API Reference spikard v#0.15.6-rc.7
Copy MarkdownModules
High-level API for spikard
API Key authentication configuration
AsyncAPI HTTP endpoint configuration
Configuration for in-process background task execution.
Compression configuration shared across runtimes
Contact information
CORS configuration for a route
Configuration for fully-featured schemas with Query, Mutation, and Subscription types
Configuration for GraphQL routes
Snapshot of a GraphQL subscription exchange over WebSocket.
Configuration for gRPC support
JSON-RPC server configuration
JSON-RPC method metadata for routes that support JSON-RPC
JWT authentication configuration
License information
HTTP method
OpenAPI configuration
Request body for POST /asyncapi/parse
Full parse result returned by POST /asyncapi/parse
A single channel extracted from an AsyncAPI spec
A resolved message (name + JSON Schema)
A single operation extracted from an AsyncAPI spec
RFC 9457 Problem Details for HTTP APIs
Configuration for schemas with Query and Mutation types
Configuration for schemas with only Query type
Rate limiting configuration shared across runtimes
HTTP Response with custom status code, headers, and content
Snapshot of an Axum response used by higher-level language bindings.
Configuration for GraphQL schema building.
Security scheme types
Server configuration
Server information
Possible errors while converting an Axum response into a snapshot.
An individual SSE event
Static file serving configuration
A single Server-Sent Event.
Request body for POST /asyncapi/validate
Response body for POST /asyncapi/validate
A WebSocket message that can be text or binary.