PHP API Reference

PHP API Reference v0.17.0-rc.4¶

Functions¶

schemaQueryOnly()¶

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:

public static function schemaQueryOnly(): QueryOnlyConfig

Example:

$result = schemaQueryOnly();

Returns: QueryOnlyConfig

schemaQueryMutation()¶

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:

public static function schemaQueryMutation(): QueryMutationConfig

Example:

$result = schemaQueryMutation();

Returns: QueryMutationConfig

schemaFull()¶

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:

public static function schemaFull(): FullSchemaConfig

Example:

$result = schemaFull();

Returns: FullSchemaConfig

Types¶

ApiKeyConfig¶

API Key authentication configuration

AsyncApiConfig¶

AsyncAPI HTTP endpoint configuration

BackgroundJobMetadata¶

Methods¶

default()¶

Signature:

public static function default(): BackgroundJobMetadata

Example:

$result = BackgroundJobMetadata::default();

Returns: BackgroundJobMetadata

BackgroundTaskConfig¶

Configuration for in-process background task execution.

Methods¶

default()¶

Signature:

public static function default(): BackgroundTaskConfig

Example:

$result = BackgroundTaskConfig::default();

Returns: BackgroundTaskConfig

CompressionConfig¶

Compression configuration shared across runtimes

Methods¶

default()¶

Signature:

public static function default(): CompressionConfig

Example:

$result = CompressionConfig::default();

Returns: CompressionConfig

ContactInfo¶

Contact information

CorsConfig¶

CORS configuration for a route

Methods¶

allowedMethodsJoined()¶

Get the cached joined methods string for preflight responses

Signature:

public function allowedMethodsJoined(): string

Example:

$result = $instance->allowedMethodsJoined();

Returns: string

allowedHeadersJoined()¶

Get the cached joined headers string for preflight responses

Signature:

public function allowedHeadersJoined(): string

Example:

$result = $instance->allowedHeadersJoined();

Returns: string

isOriginAllowed()¶

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

Signature:

public function isOriginAllowed(string $origin): bool

Example:

$result = $instance->isOriginAllowed("value");

Parameters:

Returns: bool

isMethodAllowed()¶

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

Signature:

public function isMethodAllowed(string $method): bool

Example:

$result = $instance->isMethodAllowed("value");

Parameters:

Returns: bool

default()¶

Signature:

public static function default(): CorsConfig

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:

public static function default(): FullSchemaConfig

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:

public static function new(): GraphQlRouteConfig

Example:

$result = GraphQlRouteConfig::new();

Returns: GraphQlRouteConfig

path()¶

Set the HTTP path for the GraphQL endpoint

Signature:

public function path(string $path): GraphQlRouteConfig

Example:

$result = $instance->path("value");

Parameters:

Returns: GraphQlRouteConfig

method()¶

Set the HTTP method for the GraphQL endpoint

Signature:

public function method(string $method): GraphQlRouteConfig

Example:

$result = $instance->method("value");

Parameters:

Returns: GraphQlRouteConfig

enablePlayground()¶

Enable or disable the GraphQL Playground UI

Signature:

public function enablePlayground(bool $enable): GraphQlRouteConfig

Example:

$result = $instance->enablePlayground(true);

Parameters:

Returns: GraphQlRouteConfig

description()¶

Set a custom description for documentation

Signature:

public function description(string $description): GraphQlRouteConfig

Example:

$result = $instance->description("value");

Parameters:

Returns: GraphQlRouteConfig

getPath()¶

Get the configured path

Signature:

public function getPath(): string

Example:

$result = $instance->getPath();

Returns: string

getMethod()¶

Get the configured method

Signature:

public function getMethod(): string

Example:

$result = $instance->getMethod();

Returns: string

isPlaygroundEnabled()¶

Check if playground is enabled

Signature:

public function isPlaygroundEnabled(): bool

Example:

$result = $instance->isPlaygroundEnabled();

Returns: bool

getDescription()¶

Get the description if set

Signature:

public function getDescription(): ?string

Example:

$result = $instance->getDescription();

Returns: ?string

default()¶

Signature:

public static function default(): GraphQlRouteConfig

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 null (unbounded).

Methods¶

default()¶

Signature:

public static function default(): GrpcConfig

Example:

$result = GrpcConfig::default();

Returns: GrpcConfig

IntoHandler¶

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

Methods¶

intoHandler()¶

Convert this value into a shared request handler.

Signature:

public function intoHandler(): Handler

Example:

$result = $instance->intoHandler();

Returns: Handler

JsonRpcConfig¶

JSON-RPC server configuration

Methods¶

default()¶

Signature:

public static function default(): JsonRpcConfig

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:

public static function default(): OpenApiConfig

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¶

withDetail()¶

Set the detail field

Signature:

public function withDetail(string $detail): ProblemDetails

Example:

$result = $instance->withDetail("value");

Parameters:

Returns: ProblemDetails

withInstance()¶

Set the instance field

Signature:

public function withInstance(string $instance): ProblemDetails

Example:

$result = $instance->withInstance("value");

Parameters:

Returns: ProblemDetails

notFound()¶

Create a not found error

Signature:

public static function notFound(string $detail): ProblemDetails

Example:

$result = ProblemDetails::notFound("value");

Parameters:

Returns: ProblemDetails

methodNotAllowed()¶

Create a method not allowed error

Signature:

public static function methodNotAllowed(string $detail): ProblemDetails

Example:

$result = ProblemDetails::methodNotAllowed("value");

Parameters:

Returns: ProblemDetails

internalServerError()¶

Create an internal server error

Signature:

public static function internalServerError(string $detail): ProblemDetails

Example:

$result = ProblemDetails::internalServerError("value");

Parameters:

Returns: ProblemDetails

badRequest()¶

Create a bad request error

Signature:

public static function badRequest(string $detail): ProblemDetails

Example:

$result = ProblemDetails::badRequest("value");

Parameters:

Returns: ProblemDetails

toJson()¶

Serialize to JSON string

Errors: Returns an error if the serialization fails.

Signature:

public function toJson(): string

Example:

$result = $instance->toJson();

Returns: string

Errors: Throws Error.

toJsonPretty()¶

Serialize to pretty JSON string

Errors: Returns an error if the serialization fails.

Signature:

public function toJsonPretty(): string

Example:

$result = $instance->toJsonPretty();

Returns: string

Errors: Throws Error.

QueryMutationConfig¶

Configuration for schemas with Query and Mutation types

Methods¶

default()¶

Signature:

public static function default(): QueryMutationConfig

Example:

$result = QueryMutationConfig::default();

Returns: QueryMutationConfig

QueryOnlyConfig¶

Configuration for schemas with only Query type

Methods¶

default()¶

Signature:

public static function default(): QueryOnlyConfig

Example:

$result = QueryOnlyConfig::default();

Returns: QueryOnlyConfig

RateLimitConfig¶

Rate limiting configuration shared across runtimes

Methods¶

default()¶

Signature:

public static function default(): RateLimitConfig

Example:

$result = RateLimitConfig::default();

Returns: RateLimitConfig

Request¶

Response¶

HTTP Response with custom status code, headers, and content

Methods¶

setHeader()¶

Set a header

Signature:

public function setHeader(string $key, string $value): void

Example:

$instance->setHeader("value", "value");

Parameters:

Returns: No return value.

setCookie()¶

Set a cookie in the response

Signature:

public function setCookie(string $key, string $value, bool $secure, bool $httpOnly, int $maxAge, string $domain, string $path, string $sameSite): void

Example:

$instance->setCookie("value", "value", true, true, 42, "value", "value", "value");

Parameters:

Returns: No return value.

default()¶

Signature:

public static function default(): Response

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:

public function text(): string

Example:

$result = $instance->text();

Returns: string

Errors: Throws FromUtf8Error.

header()¶

Lookup header by case-insensitive name.

Signature:

public function header(string $name): ?string

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:

public static function new(Method $method, string $path): RouteBuilder

Example:

$result = RouteBuilder::new(new Method(), "value");

Parameters:

Returns: RouteBuilder

handlerName()¶

Assign an explicit handler name.

Signature:

public function handlerName(string $name): RouteBuilder

Example:

$result = $instance->handlerName("value");

Parameters:

Returns: RouteBuilder

requestSchemaJson()¶

Provide a raw JSON schema for the request body.

Signature:

public function requestSchemaJson(mixed $schema): RouteBuilder

Example:

$result = $instance->requestSchemaJson([]);

Parameters:

Returns: RouteBuilder

responseSchemaJson()¶

Provide a raw JSON schema for the response body.

Signature:

public function responseSchemaJson(mixed $schema): RouteBuilder

Example:

$result = $instance->responseSchemaJson([]);

Parameters:

Returns: RouteBuilder

paramsSchemaJson()¶

Provide a raw JSON schema for request parameters.

Signature:

public function paramsSchemaJson(mixed $schema): RouteBuilder

Example:

$result = $instance->paramsSchemaJson([]);

Parameters:

Returns: RouteBuilder

fileParamsJson()¶

Provide multipart file parameter configuration.

Signature:

public function fileParamsJson(mixed $schema): RouteBuilder

Example:

$result = $instance->fileParamsJson([]);

Parameters:

Returns: RouteBuilder

cors()¶

Attach a CORS configuration for this route.

Signature:

public function cors(CorsConfig $cors): RouteBuilder

Example:

$result = $instance->cors(new CorsConfig());

Parameters:

Returns: RouteBuilder

compression()¶

Attach a compression configuration for this route.

Signature:

public function compression(CompressionConfig $compression): RouteBuilder

Example:

$result = $instance->compression(new CompressionConfig());

Parameters:

Returns: RouteBuilder

bodyLimit()¶

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

Signature:

public function bodyLimit(int $maxBytes): RouteBuilder

Example:

$result = $instance->bodyLimit(42);

Parameters:

Returns: RouteBuilder

requestTimeout()¶

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

Signature:

public function requestTimeout(int $seconds): RouteBuilder

Example:

$result = $instance->requestTimeout(42);

Parameters:

Returns: RouteBuilder

sync()¶

Mark the route as synchronous.

Signature:

public function sync(): RouteBuilder

Example:

$result = $instance->sync();

Returns: RouteBuilder

handlerDependencies()¶

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

Signature:

public function handlerDependencies(array<string> $dependencies): RouteBuilder

Example:

$result = $instance->handlerDependencies([]);

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:

public static function default(): SchemaConfig

Example:

$result = SchemaConfig::default();

Returns: SchemaConfig

ServerConfig¶

Server configuration

Methods¶

default()¶

Signature:

public static function default(): ServerConfig

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¶

withId()¶

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:

public function withId(string $id): SseEvent

Example:

$result = $instance->withId("value");

Parameters:

Returns: SseEvent

withRetry()¶

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:

public function withRetry(int $retryMs): SseEvent

Example:

$result = $instance->withRetry(42);

Parameters:

Returns: SseEvent

StaticFilesConfig¶

Static file serving configuration

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¶

asBytes()¶

Get the raw file content as bytes.

This provides zero-copy access to the underlying buffer.

Signature:

public function asBytes(): string

Example:

$result = $instance->asBytes();

Returns: string

readToString()¶

Read the file content as a UTF-8 string.

Errors:

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

Signature:

public function readToString(): string

Example:

$result = $instance->readToString();

Returns: string

Errors: Throws Error.

contentTypeOrDefault()¶

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

Signature:

public function contentTypeOrDefault(): string

Example:

$result = $instance->contentTypeOrDefault();

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