Struct SecurityScheme 

pub struct SecurityScheme {
    pub scheme_type: String,
    pub description: Option<String>,
    pub name: Option<String>,
    pub location: Option<String>,
    pub scheme: Option<String>,
    pub bearer_format: Option<String>,
    pub flows: Option<OAuthFlows>,
    pub open_id_connect_url: Option<String>,
}

Security scheme definition

Fields

scheme_type: String

Type of security scheme

description: Option<String>

Description

name: Option<String>

Header/query parameter name (for apiKey)

location: Option<String>

Location (header, query, cookie) for apiKey

scheme: Option<String>

Scheme name (for http)

bearer_format: Option<String>

Bearer format (for http bearer)

flows: Option<OAuthFlows>

OAuth flows

open_id_connect_url: Option<String>

OpenID Connect URL

Implementations

impl SecurityScheme

pub fn api_key(name: impl Into<String>, location: impl Into<String>) -> Self

Create an API key security scheme

pub fn bearer(format: impl Into<String>) -> Self

Create a bearer token security scheme

pub fn basic() -> Self

Create a basic auth security scheme

pub fn oauth2(flows: OAuthFlows) -> Self

Create an OAuth2 security scheme

pub fn openid_connect(url: impl Into<String>) -> Self

Create an OpenID Connect security scheme

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

Set description

Trait Implementations

impl Clone for SecurityScheme

fn clone(&self) -> SecurityScheme

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecurityScheme

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecurityScheme

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SecurityScheme

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.