Ruby API Reference

Ruby API Reference v0.17.0-rc.4¶

Functions¶

schema_query_only()¶

Create a simple schema configuration with only Query type.

This is a convenience function for schemas that only have queries.

Returns:

A QueryOnlyConfig with default settings

Signature:

def self.schema_query_only()

Example:

result = schema_query_only()

Returns: QueryOnlyConfig

schema_query_mutation()¶

Create a schema configuration with Query and Mutation types.

This is a convenience function for schemas with queries and mutations but no subscriptions.

Returns:

A QueryMutationConfig with default settings

Signature:

def self.schema_query_mutation()

Example:

result = schema_query_mutation()

Returns: QueryMutationConfig

schema_full()¶

Create a schema configuration with all three root types.

This is a convenience function for fully-featured schemas.

Returns:

A FullSchemaConfig with default settings

Signature:

def self.schema_full()

Example:

result = schema_full()

Returns: FullSchemaConfig

Types¶

ApiKeyConfig¶

API Key authentication configuration

AsyncApiConfig¶

AsyncAPI HTTP endpoint configuration

BackgroundJobMetadata¶

Methods¶

default()¶

Signature:

def self.default()

Example:

result = BackgroundJobMetadata.default()

Returns: BackgroundJobMetadata

BackgroundTaskConfig¶

Configuration for in-process background task execution.

Methods¶

default()¶

Signature:

def self.default()

Example:

result = BackgroundTaskConfig.default()

Returns: BackgroundTaskConfig

CompressionConfig¶

Compression configuration shared across runtimes

Methods¶

default()¶

Signature:

def self.default()

Example:

result = CompressionConfig.default()

Returns: CompressionConfig

ContactInfo¶

Contact information

CorsConfig¶

CORS configuration for a route

Methods¶

allowed_methods_joined()¶

Get the cached joined methods string for preflight responses

Signature:

def allowed_methods_joined()

Example:

result = instance.allowed_methods_joined()

Returns: String

allowed_headers_joined()¶

Get the cached joined headers string for preflight responses

Signature:

def allowed_headers_joined()

Example:

result = instance.allowed_headers_joined()

Returns: String

is_origin_allowed()¶

Check if an origin is allowed (O(1) with wildcard, O(n) for exact match)

Signature:

def is_origin_allowed(origin)

Example:

result = instance.is_origin_allowed("value")

Parameters:

Returns: Boolean

is_method_allowed()¶

Check if a method is allowed (O(1) with wildcard, O(n) for exact match)

Signature:

def is_method_allowed(method)

Example:

result = instance.is_method_allowed("value")

Parameters:

Returns: Boolean

default()¶

Signature:

def self.default()

Example:

result = CorsConfig.default()

Returns: CorsConfig

DynamicSchemaConfig¶

Configuration for building and executing a dynamic-SDL schema.

FieldErrorSpec¶

A field-level error to inject at a specific response path.

path is the dot-separated sequence of field names from the operation root to the field that should fail, e.g. "user" for a top-level field or "order.customer" for a nested one.

FullSchemaConfig¶

Configuration for fully-featured schemas with Query, Mutation, and Subscription types

Methods¶

default()¶

Signature:

def self.default()

Example:

result = FullSchemaConfig.default()

Returns: FullSchemaConfig

GraphQlRouteConfig¶

Configuration for GraphQL routes

Provides a builder pattern for configuring GraphQL route parameters for the Spikard HTTP server's routing system.

Methods¶

new()¶

Create a new GraphQL route configuration with defaults

Default values:

• path: "/graphql"
• method: "POST"
• enable_playground: false

Signature:

def self.new()

Example:

result = GraphQlRouteConfig.new()

Returns: GraphQlRouteConfig

path()¶

Set the HTTP path for the GraphQL endpoint

Signature:

def path(path)

Example:

result = instance.path("value")

Parameters:

Returns: GraphQlRouteConfig

method()¶

Set the HTTP method for the GraphQL endpoint

Signature:

def method(method)

Example:

result = instance.method("value")

Parameters:

Returns: GraphQlRouteConfig

enable_playground()¶

Enable or disable the GraphQL Playground UI

Signature:

def enable_playground(enable)

Example:

result = instance.enable_playground(true)

Parameters:

Returns: GraphQlRouteConfig

description()¶

Set a custom description for documentation

Signature:

def description(description)

Example:

result = instance.description("value")

Parameters:

Returns: GraphQlRouteConfig

get_path()¶

Get the configured path

Signature:

def get_path()

Example:

result = instance.get_path()

Returns: String

get_method()¶

Get the configured method

Signature:

def get_method()

Example:

result = instance.get_method()

Returns: String

is_playground_enabled()¶

Check if playground is enabled

Signature:

def is_playground_enabled()

Example:

result = instance.is_playground_enabled()

Returns: Boolean

get_description()¶

Get the description if set

Signature:

def get_description()

Example:

result = instance.get_description()

Returns: String?

default()¶

Signature:

def self.default()

Example:

result = GraphQlRouteConfig.default()

Returns: GraphQlRouteConfig

GraphQlSubscriptionSnapshot¶

Snapshot of a GraphQL subscription exchange over WebSocket.

GrpcConfig¶

Configuration for gRPC support

Controls how the server handles gRPC requests, including compression, timeouts, and protocol settings.

Stream Limits¶

This configuration enforces message-level size limits but delegates concurrent stream limiting to the HTTP/2 transport layer:

• Message Size Limits: The max_message_size field is enforced per individual message (request or response) in both unary and streaming RPCs. When a single message exceeds this limit, the request is rejected with PAYLOAD_TOO_LARGE (HTTP 413).

• Concurrent Stream Limits: The max_concurrent_streams is an advisory configuration passed to the HTTP/2 layer for connection-level stream negotiation. The HTTP/2 transport automatically enforces this limit and returns GOAWAY frames when exceeded. Applications should not rely on custom enforcement of this limit.

• Stream Response Size Limits: The max_stream_response_bytes field caps the total encoded bytes emitted across a server-streaming or bidi-streaming response. When the cumulative size exceeds the limit, the stream is terminated with tonic.Status.resource_exhausted. Defaults to nil (unbounded).

Methods¶

default()¶

Signature:

def self.default()

Example:

result = GrpcConfig.default()

Returns: GrpcConfig

IntoHandler¶

Convert user-facing handler functions into the low-level Handler trait.

Methods¶

into_handler()¶

Convert this value into a shared request handler.

Signature:

def into_handler()

Example:

result = instance.into_handler()

Returns: Handler

JsonRpcConfig¶

JSON-RPC server configuration

Methods¶

default()¶

Signature:

def self.default()

Example:

result = JsonRpcConfig.default()

Returns: JsonRpcConfig

JsonRpcMethodInfo¶

JSON-RPC method metadata for routes that support JSON-RPC

This struct captures the metadata needed to expose HTTP routes as JSON-RPC methods, enabling discovery and documentation of RPC-compatible endpoints.

JwtConfig¶

JWT authentication configuration

LicenseInfo¶

License information

OpenApiConfig¶

OpenAPI configuration

Methods¶

default()¶

Signature:

def self.default()

Example:

result = OpenApiConfig.default()

Returns: OpenApiConfig

ParseRequest¶

Request body for POST /asyncapi/parse

ParseResult¶

Full parse result returned by POST /asyncapi/parse

ParsedChannel¶

A single channel extracted from an AsyncAPI spec

ParsedMessage¶

A resolved message (name + JSON Schema)

ParsedOperation¶

A single operation extracted from an AsyncAPI spec

ProblemDetails¶

RFC 9457 Problem Details for HTTP APIs

A machine-readable format for specifying errors in HTTP API responses. Per RFC 9457, all fields are optional. The type field defaults to "about:blank" if not specified.

Content-Type¶

Responses using this struct should set:

Content-Type: application/problem+json

{
  "type": "<https://spikard.dev/errors/validation-error",>
  "title": "Request Validation Failed",
  "status": 422,
  "detail": "2 validation errors in request body",
  "errors": [...]
}

Methods¶

with_detail()¶

Set the detail field

Signature:

def with_detail(detail)

Example:

result = instance.with_detail("value")

Parameters:

Returns: ProblemDetails

with_instance()¶

Set the instance field

Signature:

def with_instance(instance)

Example:

result = instance.with_instance("value")

Parameters:

Returns: ProblemDetails

not_found()¶

Create a not found error

Signature:

def self.not_found(detail)

Example:

result = ProblemDetails.not_found("value")

Parameters:

Returns: ProblemDetails

method_not_allowed()¶

Create a method not allowed error

Signature:

def self.method_not_allowed(detail)

Example:

result = ProblemDetails.method_not_allowed("value")

Parameters:

Returns: ProblemDetails

internal_server_error()¶

Create an internal server error

Signature:

def self.internal_server_error(detail)

Example:

result = ProblemDetails.internal_server_error("value")

Parameters:

Returns: ProblemDetails

bad_request()¶

Create a bad request error

Signature:

def self.bad_request(detail)

Example:

result = ProblemDetails.bad_request("value")

Parameters:

Returns: ProblemDetails

to_json()¶

Serialize to JSON string

Errors: Returns an error if the serialization fails.

Signature:

def to_json()

Example:

result = instance.to_json()

Returns: String

Errors: Raises Error.

to_json_pretty()¶

Serialize to pretty JSON string

Errors: Returns an error if the serialization fails.

Signature:

def to_json_pretty()

Example:

result = instance.to_json_pretty()

Returns: String

Errors: Raises Error.

QueryMutationConfig¶

Configuration for schemas with Query and Mutation types

Methods¶

default()¶

Signature:

def self.default()

Example:

result = QueryMutationConfig.default()

Returns: QueryMutationConfig

QueryOnlyConfig¶

Configuration for schemas with only Query type

Methods¶

default()¶

Signature:

def self.default()

Example:

result = QueryOnlyConfig.default()

Returns: QueryOnlyConfig

RateLimitConfig¶

Rate limiting configuration shared across runtimes

Methods¶

default()¶

Signature:

def self.default()

Example:

result = RateLimitConfig.default()

Returns: RateLimitConfig

Response¶

HTTP Response with custom status code, headers, and content

Methods¶

set_header()¶

Set a header

Signature:

def set_header(key, value)

Example:

instance.set_header("value", "value")

Parameters:

Returns: No return value.

set_cookie()¶

Set a cookie in the response

Signature:

def set_cookie(key, value, secure, http_only, max_age, domain, path, same_site)

Example:

instance.set_cookie("value", "value", true, true, max_age: 42, domain: "value", path: "value", same_site: "value")

Parameters:

Returns: No return value.

default()¶

Signature:

def self.default()

Example:

result = Response.default()

Returns: Response

ResponseSnapshot¶

Snapshot of an Axum response used by higher-level language bindings.

Methods¶

text()¶

Return response body as UTF-8 string.

Signature:

def text()

Example:

result = instance.text()

Returns: String

Errors: Raises FromUtf8Error.

header()¶

Lookup header by case-insensitive name.

Signature:

def header(name)

Example:

result = instance.header("value")

Parameters:

Returns: String?

RouteBuilder¶

Builder for defining a route.

Methods¶

new()¶

Create a new builder for the provided HTTP method and path.

Signature:

def self.new(method, path)

Example:

result = RouteBuilder.new(Method.new, "value")

Parameters:

Returns: RouteBuilder

handler_name()¶

Assign an explicit handler name.

Signature:

def handler_name(name)

Example:

result = instance.handler_name("value")

Parameters:

Returns: RouteBuilder

request_schema_json()¶

Provide a raw JSON schema for the request body.

Signature:

def request_schema_json(schema)

Example:

result = instance.request_schema_json([])

Parameters:

Returns: RouteBuilder

response_schema_json()¶

Provide a raw JSON schema for the response body.

Signature:

def response_schema_json(schema)

Example:

result = instance.response_schema_json([])

Parameters:

Returns: RouteBuilder

params_schema_json()¶

Provide a raw JSON schema for request parameters.

Signature:

def params_schema_json(schema)

Example:

result = instance.params_schema_json([])

Parameters:

Returns: RouteBuilder

file_params_json()¶

Provide multipart file parameter configuration.

Signature:

def file_params_json(schema)

Example:

result = instance.file_params_json([])

Parameters:

Returns: RouteBuilder

cors()¶

Attach a CORS configuration for this route.

Signature:

def cors(cors)

Example:

result = instance.cors(CorsConfig.new)

Parameters:

Returns: RouteBuilder

compression()¶

Attach a compression configuration for this route.

Signature:

def compression(compression)

Example:

result = instance.compression(CompressionConfig.new)

Parameters:

Returns: RouteBuilder

body_limit()¶

Attach a per-route maximum request body size in bytes, overriding the server-global default.

Signature:

def body_limit(max_bytes)

Example:

result = instance.body_limit(42)

Parameters:

Returns: RouteBuilder

request_timeout()¶

Attach a per-route request timeout in seconds, overriding the server-global default.

Signature:

def request_timeout(seconds)

Example:

result = instance.request_timeout(42)

Parameters:

Returns: RouteBuilder

sync()¶

Mark the route as synchronous.

Signature:

def sync()

Example:

result = instance.sync()

Returns: RouteBuilder

handler_dependencies()¶

Declare the dependency keys that must be resolved before this handler runs.

Signature:

def handler_dependencies(dependencies)

Example:

result = instance.handler_dependencies([])

Parameters:

Returns: RouteBuilder

SchemaConfig¶

Configuration for GraphQL schema building.

Encapsulates all schema-level configuration options including introspection control, complexity limits, and depth limits.

Methods¶

default()¶

Signature:

def self.default()

Example:

result = SchemaConfig.default()

Returns: SchemaConfig

ServerConfig¶

Server configuration

Methods¶

default()¶

Signature:

def self.default()

Example:

result = ServerConfig.default()

Returns: ServerConfig

ServerInfo¶

Server information

SseEvent¶

An individual SSE event

Represents a single Server-Sent Event to be sent to a connected client. Events can have an optional type, ID, and retry timeout for advanced scenarios.

SSE Format¶

Events are serialized to the following text format:

event: event_type
data: {"json":"value"}
id: event-123
retry: 3000

Methods¶

with_id()¶

Set the event ID for client-side reconnection support

Sets an ID that clients can use to resume from this point if they disconnect. The client sends this ID back in the Last-Event-ID header when reconnecting.

Signature:

def with_id(id)

Example:

result = instance.with_id("value")

Parameters:

Returns: SseEvent

with_retry()¶

Set the retry timeout for client reconnection

Sets the time in milliseconds clients should wait before attempting to reconnect if the connection is lost. The client browser will automatically handle reconnection.

Signature:

def with_retry(retry_ms)

Example:

result = instance.with_retry(42)

Parameters:

Returns: SseEvent

StaticFilesConfig¶

Static file serving configuration

TestClient¶

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.

Methods¶

graphql_at()¶

Send a GraphQL query/mutation to a custom endpoint

Signature:

def graphql_at(endpoint, query, variables, operation_name)

Example:

result = instance.graphql_at("value", "value", variables: [], operation_name: "value")

Parameters:

Returns: ResponseSnapshot

Errors: Raises SnapshotError.

graphql()¶

Send a GraphQL query/mutation

Signature:

def graphql(query, variables, operation_name)

Example:

result = instance.graphql("value", variables: [], operation_name: "value")

Parameters:

Returns: ResponseSnapshot

Errors: Raises SnapshotError.

graphql_subscription_at()¶

Send a GraphQL subscription (WebSocket) to a custom endpoint.

Uses the graphql-transport-ws protocol and captures the first next payload. After the first payload is received, this client sends complete to unsubscribe.

Signature:

def graphql_subscription_at(endpoint, query, variables, operation_name)

Example:

result = instance.graphql_subscription_at("value", "value", variables: [], operation_name: "value")

Parameters:

Returns: GraphQlSubscriptionSnapshot

Errors: Raises SnapshotError.

graphql_subscription()¶

Send a GraphQL subscription (WebSocket).

Uses /graphql as the default subscription endpoint.

Signature:

def graphql_subscription(query, variables, operation_name)

Example:

result = instance.graphql_subscription("value", variables: [], operation_name: "value")

Parameters:

Returns: GraphQlSubscriptionSnapshot

Errors: Raises SnapshotError.

TestingSseEvent¶

A single Server-Sent Event.

UploadFile¶

Represents an uploaded file from multipart/form-data requests.

This struct provides efficient access to file content with automatic base64 decoding and implements standard I/O traits for compatibility.

Methods¶

as_bytes()¶

Get the raw file content as bytes.

This provides zero-copy access to the underlying buffer.

Signature:

def as_bytes()

Example:

result = instance.as_bytes()

Returns: String

read_to_string()¶

Read the file content as a UTF-8 string.

Errors:

Returns an error if the content is not valid UTF-8.

Signature:

def read_to_string()

Example:

result = instance.read_to_string()

Returns: String

Errors: Raises Error.

content_type_or_default()¶

Get the content type, defaulting to "application/octet-stream".

Signature:

def content_type_or_default()

Example:

result = instance.content_type_or_default()

Returns: String

ValidateRequest¶

Request body for POST /asyncapi/validate

ValidationResponse¶

Response body for POST /asyncapi/validate

Enums¶

Method¶

HTTP method

SecuritySchemeInfo¶

Security scheme types

SnapshotError¶

Possible errors while converting an Axum response into a snapshot.

WebSocketMessage¶

A WebSocket message that can be text or binary.

Errors¶

AppError¶

Error type for application builder operations.

GraphQlError¶

Errors that can occur during GraphQL operations

These errors are compatible with async-graphql error handling and can be converted to structured HTTP responses matching the project's error fixtures.

SchemaError¶

Error type for schema building operations

Edit this page on GitHub