Struct OpenApiBuilder 

pub struct OpenApiBuilder { /* private fields */ }

Available on crate feature openapi only.

Builds an OpenAPI 3.0 document from a SchemaRegistry.

Implementations

impl OpenApiBuilder

pub fn new() -> Self

Creates a builder with default title and version.

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

Sets the API title in info.title.

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

Sets info.version.

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

Sets info.description.

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

Adds a server URL.

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

Adds a server URL with description.

pub fn from_registry(&self, registry: &SchemaRegistry) -> OpenApiDocument

Builds an OpenAPI 3.0 document from a SchemaRegistry.

See the openapi_export example in the repository for a full workflow.

Trait Implementations

impl Debug for OpenApiBuilder

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

Formats the value using the given formatter.

impl Default for OpenApiBuilder

fn default() -> OpenApiBuilder

Returns the “default value” for a type.