Elixir API Reference

Elixir API Reference v0.15.6-rc.3¶

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:

@spec schema_query_only() :: {:ok, term()} | {:error, term()}
def 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:

@spec schema_query_mutation() :: {:ok, term()} | {:error, term()}
def 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:

@spec schema_full() :: {:ok, term()} | {:error, term()}
def schema_full()

Returns: FullSchemaConfig

Types¶

ApiKeyConfig¶

API Key authentication configuration

AsyncApiConfig¶

AsyncAPI HTTP endpoint configuration

BackgroundJobMetadata¶

Functions¶

default()¶

Signature:

def default()

BackgroundTaskConfig¶

Configuration for in-process background task execution.

Functions¶

default()¶

Signature:

def default()

CompressionConfig¶

Compression configuration shared across runtimes

Functions¶

default()¶

Signature:

def default()

ContactInfo¶

Contact information

CorsConfig¶

CORS configuration for a route

Functions¶

allowed_methods_joined()¶

Get the cached joined methods string for preflight responses

Signature:

def allowed_methods_joined()

allowed_headers_joined()¶

Get the cached joined headers string for preflight responses

Signature:

def allowed_headers_joined()

is_origin_allowed()¶

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

Signature:

def is_origin_allowed(origin)

is_method_allowed()¶

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

Signature:

def is_method_allowed(method)

are_headers_allowed()¶

Check if all requested headers are allowed (O(n) where n = num requested headers)

Signature:

def are_headers_allowed(requested)

default()¶

Signature:

def default()

FullSchemaConfig¶

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

Functions¶

default()¶

Signature:

def default()

GraphQlRouteConfig¶

Configuration for GraphQL routes

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

Functions¶

path()¶

Set the HTTP path for the GraphQL endpoint

Signature:

def path(path)

method()¶

Set the HTTP method for the GraphQL endpoint

Signature:

def method(method)

enable_playground()¶

Enable or disable the GraphQL Playground UI

Signature:

def enable_playground(enable)

description()¶

Set a custom description for documentation

Signature:

def description(description)

get_path()¶

Get the configured path

Signature:

def get_path()

get_method()¶

Get the configured method

Signature:

def get_method()

is_playground_enabled()¶

Check if playground is enabled

Signature:

def is_playground_enabled()

get_description()¶

Get the description if set

Signature:

def get_description()

default()¶

Signature:

def default()

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).

Functions¶

default()¶

Signature:

def default()

JsonRpcConfig¶

JSON-RPC server configuration

Functions¶

default()¶

Signature:

def default()

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

Functions¶

default()¶

Signature:

def default()

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": [...]
}

Functions¶

with_detail()¶

Set the detail field

Signature:

def with_detail(detail)

with_instance()¶

Set the instance field

Signature:

def with_instance(instance)

not_found()¶

Create a not found error

Signature:

def not_found(detail)

method_not_allowed()¶

Create a method not allowed error

Signature:

def method_not_allowed(detail)

internal_server_error()¶

Create an internal server error

Signature:

def internal_server_error(detail)

bad_request()¶

Create a bad request error

Signature:

def bad_request(detail)

to_json()¶

Serialize to JSON string

Errors: Returns an error if the serialization fails.

Signature:

def to_json()

to_json_pretty()¶

Serialize to pretty JSON string

Errors: Returns an error if the serialization fails.

Signature:

def to_json_pretty()

QueryMutationConfig¶

Configuration for schemas with Query and Mutation types

Functions¶

default()¶

Signature:

def default()

QueryOnlyConfig¶

Configuration for schemas with only Query type

Functions¶

default()¶

Signature:

def default()

RateLimitConfig¶

Rate limiting configuration shared across runtimes

Functions¶

default()¶

Signature:

def default()

Response¶

HTTP Response with custom status code, headers, and content

Functions¶

set_header()¶

Set a header

Signature:

def set_header(key, value)

set_cookie()¶

Set a cookie in the response

Signature:

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

default()¶

Signature:

def default()

ResponseSnapshot¶

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

Functions¶

text()¶

Return response body as UTF-8 string.

Signature:

def text()

header()¶

Lookup header by case-insensitive name.

Signature:

def header(name)

SchemaConfig¶

Configuration for GraphQL schema building.

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

Functions¶

default()¶

Signature:

def default()

ServerConfig¶

Server configuration

Functions¶

default()¶

Signature:

def default()

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

Functions¶

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)

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)

StaticFilesConfig¶

Static file serving configuration

TestingSseEvent¶

A single Server-Sent Event.

ValidateRequest¶

Request body for POST /asyncapi/validate

ValidationResponse¶

Response body for POST /asyncapi/validate

Enums¶

SnapshotError¶

Possible errors while converting an Axum response into a snapshot.

WebSocketMessage¶

A WebSocket message that can be text or binary.

Method¶

HTTP method

SecuritySchemeInfo¶

Security scheme types

Errors¶

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