Struct OpenApiConfig 

pub struct OpenApiConfig {
    pub title: String,
    pub version: String,
    pub description: Option<String>,
    pub openapi_json_path: String,
    pub swagger_ui_path: Option<String>,
    pub session_cookie_name: String,
    pub additional_schemas: BTreeMap<String, Value>,
}

User-facing configuration for OpenAPI generation.

Passed to AppBuilder::openapi to enable spec generation and mount the documentation endpoints.

Fields

title: String

API title that appears in the Swagger UI header.

version: String

API version (e.g. "1.0.0").

description: Option<String>

Optional free-form API description (Markdown permitted in UI).

openapi_json_path: String

Path serving the raw openapi.json. Defaults to /v3/api-docs.

swagger_ui_path: Option<String>

Path serving the Swagger UI HTML. Defaults to /swagger-ui. Set to None to disable the UI while still exposing the JSON.

session_cookie_name: String

Session cookie name used by secured route security docs.

Runtime OpenAPI mounting replaces this with session.cookie_name from the loaded app config.

additional_schemas: BTreeMap<String, Value>

User-registered component schemas keyed by schema name.

Implementations

impl OpenApiConfig

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

Create a new config with the required title and version.

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

Set a free-form API description.

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

Override the path serving openapi.json.

pub fn swagger_ui_path(self, path: Option<String>) -> Self

Override the Swagger UI path (or None to disable it).

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

Override the session cookie name documented for secured routes.

pub fn register_schema(self, name: impl Into<String>, schema: Value) -> Self

Register a custom component schema. Useful when a handler’s payload type does not implement OpenApiSchema.

Trait Implementations

impl Clone for OpenApiConfig

fn clone(&self) -> OpenApiConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.