Enum SecurityScheme 

pub enum SecurityScheme {
    Http {
        scheme: String,
        bearer_format: Option<String>,
        description: Option<String>,
    },
    ApiKey {
        name: String,
        location: ApiKeyLocation,
        description: Option<String>,
    },
    OAuth2 {
        flows: Box<OAuth2Flows>,
        description: Option<String>,
    },
}

Authentication scheme, supports HTTP (Basic/Bearer), ApiKey, OAuth2

Variants

Http

HTTP authentication (Basic or Bearer)

In OpenAPI 3.0, both Basic and Bearer use type: http, distinguished by the scheme field (basic or bearer).

Fields

scheme: String

Authentication scheme: basic or bearer

bearer_format: Option<String>

Bearer format (used only when scheme=bearer, e.g., JWT)

description: Option<String>

ApiKey

API Key authentication (Header / Query / Cookie)

Fields

name: String

location: ApiKeyLocation

description: Option<String>

OAuth2

OAuth2 authentication

Fields

flows: Box<OAuth2Flows>

description: Option<String>

Implementations

impl SecurityScheme

pub fn basic() -> Self

Creates a Basic authentication scheme

pub fn bearer(jwt_format: bool) -> Self

Creates a Bearer Token authentication scheme

pub fn api_key(name: &str, location: ApiKeyLocation) -> Self

Creates an API Key authentication scheme

pub fn oauth2(flows: OAuth2Flows) -> Self

Creates an OAuth2 authentication scheme

pub fn is_basic(&self) -> bool

Determines whether it is Basic authentication

pub fn is_bearer(&self) -> bool

Determines whether it is Bearer authentication

pub fn with_description(self, desc: &str) -> Self

Sets the 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.