Struct OpenApiBuilder 

pub struct OpenApiBuilder { /* private fields */ }

Embedded builder, also used by the HTTP OpenAPI plugin.

Implementations

impl OpenApiBuilder

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

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

pub fn registered(config: &AuthConfig, registry: &OpenApiRegistry) -> Self

Construct the upstream document defaults from an immutable instance snapshot.

pub fn registered_with_native_extensions( config: &AuthConfig, registry: &OpenApiRegistry, include_native_extensions: bool, ) -> Self

Include documented Rust extensions while retaining upstream generator defaults.

pub fn annotated( self, method: &HttpMethod, path: &str, plugin: &str, core: bool, metadata: &OpenApiEndpoint, ) -> Self

pub fn route( self, method: &HttpMethod, path: &str, operation_id: &str, tag: &str, ) -> Self

pub fn plugin<S: AuthSchema>(self, plugin: &dyn AuthPlugin<S>) -> Self

Register all routes from a plugin.

pub fn core_routes(self) -> Self

Register core routes that are not part of any plugin.

pub fn build(self) -> OpenApiSpec

Build the final OpenAPI spec.

Trait Implementations

impl Debug for OpenApiBuilder

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

Formats the value using the given formatter.