Struct OpenApiDocument 

pub struct OpenApiDocument { /* private fields */ }

Minimal OpenAPI document metadata builder.

Implementations

impl OpenApiDocument

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

Creates an OpenAPI document.

pub fn route(self, route: OpenApiRoute) -> Self

Adds route metadata to the document.

pub fn try_route( self, route: OpenApiRoute, ) -> Result<Self, OpenApiDocumentError>

Tries to add route metadata to the document.

pub fn controller_routes( self, controller_prefix: &str, routes: &[RouteMetadata], ) -> Self

Adds generated route metadata under a controller prefix.

pub fn try_controller_routes( self, controller_prefix: &str, routes: &[RouteMetadata], ) -> Result<Self, OpenApiDocumentError>

Tries to add generated route metadata under a controller prefix.

pub fn schemas_from_route_metadata(self, routes: &[RouteMetadata]) -> Self

Registers schemas from route OpenAPI metadata callbacks.

pub fn try_schemas_from_route_metadata( self, routes: &[RouteMetadata], ) -> Result<Self, OpenApiDocumentError>

Tries to register schemas from route OpenAPI metadata callbacks.

pub fn schema<T>(self) -> Self

where T: ToSchema,

Adds a DTO schema generated by utoipa::ToSchema.

pub fn try_schema<T>(self) -> Result<Self, OpenApiDocumentError>

where T: ToSchema,

Tries to add a DTO schema generated by utoipa::ToSchema.

pub fn from_route_metadata( title: impl Into<String>, version: impl Into<String>, routes: &[RouteMetadata], ) -> Self

Creates an OpenAPI document from generated route metadata.

pub fn try_from_route_metadata( title: impl Into<String>, version: impl Into<String>, routes: &[RouteMetadata], ) -> Result<Self, OpenApiDocumentError>

Tries to create an OpenAPI document from generated route metadata.

pub fn from_controller_routes( title: impl Into<String>, version: impl Into<String>, controller_prefix: &str, routes: &[RouteMetadata], ) -> Self

Creates an OpenAPI document from a controller prefix and generated route metadata.

pub fn try_from_controller_routes( title: impl Into<String>, version: impl Into<String>, controller_prefix: &str, routes: &[RouteMetadata], ) -> Result<Self, OpenApiDocumentError>

Tries to create an OpenAPI document from controller route metadata.

pub fn to_json_value(&self) -> Value

Renders the document as JSON.

pub fn into_router(self) -> Router

Builds an Axum router serving OpenAPI JSON and Swagger UI docs.

Trait Implementations

impl Clone for OpenApiDocument

fn clone(&self) -> OpenApiDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiDocument

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.