Struct HttpApi 

pub struct HttpApi<H> { /* private fields */ }

Builder for the axum task API.

Authentication and metrics are optional. build returns a standalone router and OpenAPI document. mount adds the documented task subtree to an application router. router returns only the router.

Example

use std::sync::Arc;

use solti_api::{ApiHandler, HttpApi};
use solti_model::Token;

fn build<H: ApiHandler>(
    handler: Arc<H>,
    token: Token,
) -> solti_api::axum::Router {
    HttpApi::new(handler)
        .with_auth(token)
        .router()
}

See Also

• ApiHandler defines the backend operations.
• ApiError defines the HTTP Status mapping.

Implementations

impl<H> HttpApi<H>

where H: ApiHandler,

pub fn new(handler: Arc<H>) -> Self

Creates an HTTP API for one handler.

pub fn with_auth(self, token: Token) -> Self

Requires a bearer token on every request.

The expected header is Authorization: Bearer <token>. Missing or invalid credentials return 401 Unauthorized. Rejected requests do not reach the handler. Authentication is disabled when this method is not called.

pub fn with_metrics(self, metrics: ApiMetricsHandle) -> Self

Attaches a metrics backend.

The default backend ignores every update.

pub fn build(self) -> HttpApiParts

Builds a standalone router and its OpenAPI document.

Every request body is limited to MAX_REQUEST_BYTES. Optional authentication runs before the handler. Metrics include unmatched task API routes and authentication failures.

pub fn mount<S>(self, app: ApiRouter<S>, openapi: &mut OpenApi) -> ApiRouter<S>

where S: Clone + Send + Sync + 'static,

Mounts the documented task API into an application router.

The task routes are mounted at HTTP_API_ROOT. Their handler state, authentication, limits, metrics, and fallbacks stay inside that route subtree.

The caller owns the final OpenApi document. Call ApiRouter::finish_api once after every documented service has been mounted.

pub fn router(self) -> Router

Builds only the configured axum router.

Use build when the OpenAPI document is needed.