Struct TestClient 

pub struct TestClient { /* private fields */ }

Core test client for making HTTP requests to a Spikard application.

This struct wraps axum-test’s TestServer and provides a language-agnostic interface for making HTTP requests, sending WebSocket connections, and handling Server-Sent Events. Language bindings wrap this to provide native API surfaces.

Implementations

impl TestClient

pub fn from_router(router: Router) -> Result<Self, String>

Create a new test client from an Axum router

pub fn server(&self) -> &TestServer

Get the underlying test server (for WebSocket and SSE connections)

pub async fn get( &self, path: &str, query_params: Option<Vec<(String, String)>>, headers: Option<Vec<(String, String)>>, ) -> Result<ResponseSnapshot, SnapshotError>

Make a GET request

pub async fn post( &self, path: &str, json: Option<Value>, form_data: Option<Vec<(String, String)>>, multipart: Option<(Vec<(String, String)>, Vec<MultipartFilePart>)>, query_params: Option<Vec<(String, String)>>, headers: Option<Vec<(String, String)>>, ) -> Result<ResponseSnapshot, SnapshotError>

Make a POST request

pub async fn request_raw( &self, method: Method, path: &str, body: Bytes, query_params: Option<Vec<(String, String)>>, headers: Option<Vec<(String, String)>>, ) -> Result<ResponseSnapshot, SnapshotError>

Make a request with a raw body payload.

pub async fn put( &self, path: &str, json: Option<Value>, query_params: Option<Vec<(String, String)>>, headers: Option<Vec<(String, String)>>, ) -> Result<ResponseSnapshot, SnapshotError>

Make a PUT request

pub async fn patch( &self, path: &str, json: Option<Value>, query_params: Option<Vec<(String, String)>>, headers: Option<Vec<(String, String)>>, ) -> Result<ResponseSnapshot, SnapshotError>

Make a PATCH request

pub async fn delete( &self, path: &str, query_params: Option<Vec<(String, String)>>, headers: Option<Vec<(String, String)>>, ) -> Result<ResponseSnapshot, SnapshotError>

Make a DELETE request

pub async fn options( &self, path: &str, query_params: Option<Vec<(String, String)>>, headers: Option<Vec<(String, String)>>, ) -> Result<ResponseSnapshot, SnapshotError>

Make an OPTIONS request

pub async fn head( &self, path: &str, query_params: Option<Vec<(String, String)>>, headers: Option<Vec<(String, String)>>, ) -> Result<ResponseSnapshot, SnapshotError>

Make a HEAD request

pub async fn trace( &self, path: &str, query_params: Option<Vec<(String, String)>>, headers: Option<Vec<(String, String)>>, ) -> Result<ResponseSnapshot, SnapshotError>

Make a TRACE request

pub async fn graphql_at( &self, endpoint: &str, query: &str, variables: Option<Value>, operation_name: Option<&str>, ) -> Result<ResponseSnapshot, SnapshotError>

Send a GraphQL query/mutation to a custom endpoint

pub async fn graphql( &self, query: &str, variables: Option<Value>, operation_name: Option<&str>, ) -> Result<ResponseSnapshot, SnapshotError>

Send a GraphQL query/mutation

pub async fn graphql_with_status( &self, query: &str, variables: Option<Value>, operation_name: Option<&str>, ) -> Result<(u16, ResponseSnapshot), SnapshotError>

Send a GraphQL query and return HTTP status code separately

This method allows tests to distinguish between:

• HTTP-level errors (400/422 for invalid requests)
• GraphQL-level errors (200 with errors in response body)

Example

let (status, snapshot) = client.graphql_with_status(
    "query { invalid syntax",
    None,
    None
).await?;
assert_eq!(status, 400); // HTTP parse error

pub async fn graphql_subscription( &self, _query: &str, _variables: Option<Value>, _operation_name: Option<&str>, ) -> Result<(), SnapshotError>

Send a GraphQL subscription (WebSocket)