Struct OpenApi 

pub struct OpenApi { /* private fields */ }

Configures OpenAPI document generation.

The document describes paths, methods, summaries, descriptions, tags, path parameters, and — for routes whose handlers use #[api_model] bodies and return types — request and response body schemas under components.schemas.

Implementations

impl OpenApi

pub fn new() -> Self

Creates a builder with default title, version, and document path.

pub fn title(self, title: impl Into<String>) -> Self

Sets the API title.

pub fn version(self, version: impl Into<String>) -> Self

Sets the API version.

pub fn description(self, description: impl Into<String>) -> Self

Sets the API description.

pub fn json(self, path: impl Into<String>) -> Self

Sets the path at which the specification document is served.

pub fn docs(self, path: impl Into<String>) -> Self

Enables the documentation UI, served at path.

pub fn protect<F>(self, predicate: F) -> Self

where F: Fn(&RequestContext) -> bool + Send + Sync + 'static,

Restricts access to the spec and docs routes to requests the predicate accepts; rejected requests get a 404 (hiding that the routes exist).

Use this to keep the API surface from being publicly discoverable — for example, gate it on a bearer token, an internal network, or an environment flag. The predicate runs on every request to the documentation routes.

Compare the credential with constant_time_eq rather than ==, so the check does not leak how many bytes matched via its timing:

use tork_core::security::constant_time_eq;
let api = OpenApi::new().docs("/docs").protect(|ctx| {
    ctx.headers()
        .get("authorization")
        .and_then(|v| v.to_str().ok())
        .map(|header| constant_time_eq(header, "Bearer secret-docs-token"))
        .unwrap_or(false)
});

pub fn build_document(&self, routes: &[Route]) -> Value

Builds the OpenAPI document for the given routes as a JSON value.

Trait Implementations

impl Default for OpenApi

fn default() -> Self

Returns the “default value” for a type.

impl OpenApiProvider for OpenApi

fn documentation_routes(&self, registered: &[Route]) -> Vec<Route>

Given the application’s registered routes, returns extra routes that serve the specification document and the documentation UI.