Struct utoipa::openapi::security::HttpBuilder

pub struct HttpBuilder { /* private fields */ }

Builder for Http with chainable configuration methods to create a new Http.

Implementations

impl HttpBuilder

pub fn new() -> HttpBuilder

Constructs a new HttpBuilder.

pub fn build(self) -> Http

Constructs a new Http taking all fields values from this object.

impl HttpBuilder

pub fn scheme(self, scheme: HttpAuthScheme) -> Self

Add or change http authentication scheme used.

Examples

Create new Http SecurityScheme via HttpBuilder.

let http = HttpBuilder::new().scheme(HttpAuthScheme::Basic).build();

pub fn bearer_format<S: Into<String>>(self, bearer_format: S) -> Self

Add or change informative bearer format for http security schema.

This is only applicable to HttpAuthScheme::Bearer.

Examples

Add JTW bearer format for security schema.

HttpBuilder::new().scheme(HttpAuthScheme::Bearer).bearer_format("JWT").build();

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

Add or change optional description supporting markdown syntax.

Trait Implementations

impl Default for HttpBuilder

fn default() -> HttpBuilder

Returns the “default value” for a type.

impl From<Http> for HttpBuilder

fn from(value: Http) -> Self

Converts to this type from the input type.

impl From<HttpBuilder> for Http

fn from(value: HttpBuilder) -> Self

Converts to this type from the input type.