Struct OpenApiBuilder 

pub struct OpenApiBuilder { /* private fields */ }

Builder for OpenAPI specifications

Implementations

impl OpenApiBuilder

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

Create a new OpenAPI builder

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

Set description

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

Set terms of service

pub fn contact( self, name: Option<String>, url: Option<String>, email: Option<String>, ) -> Self

Add contact information

pub fn license(self, name: impl Into<String>, url: Option<String>) -> Self

Add license

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

Add a server

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

Add a tag

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

Add a path

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

Add a schema component

pub fn security_scheme( self, name: impl Into<String>, scheme: SecurityScheme, ) -> Self

Add a security scheme

pub fn security(self, requirement: SecurityRequirement) -> Self

Add global security requirement

pub fn build(self) -> OpenApiSpec

Build the OpenAPI specification

impl OpenApiBuilder

Helper functions for creating common components

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

Add Bearer JWT authentication

pub fn add_api_key_auth( self, name: impl Into<String>, key_name: impl Into<String>, location: ApiKeyLocation, ) -> Self

Add API key authentication

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

Add OpenID Connect authentication

Trait Implementations

impl Clone for OpenApiBuilder

fn clone(&self) -> OpenApiBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiBuilder

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

Formats the value using the given formatter.