Struct SecurityScheme 

pub struct SecurityScheme { /* private fields */ }

A way for clients to authenticate, such as a bearer token or an API key.

Register it under a name with OpenApi::security_scheme, then require it with Operation::security:

use topcoat::openapi::{OpenApi, Operation, SecurityScheme};

let api = OpenApi::new("Acme API", "1.0.0")
    .security_scheme("token", SecurityScheme::bearer().bearer_format("JWT"));
let operation = Operation::new().security("token");

Implementations

impl SecurityScheme

pub fn bearer() -> Self

Authenticates with a token sent as Authorization: Bearer <token>.

pub fn basic() -> Self

Authenticates with a user name and password sent through HTTP basic authentication.

pub fn api_key_header(name: impl Into<Cow<'static, str>>) -> Self

Authenticates with an API key sent in the request header name.

pub fn api_key_query(name: impl Into<Cow<'static, str>>) -> Self

Authenticates with an API key sent as the query string key name.

pub fn api_key_cookie(name: impl Into<Cow<'static, str>>) -> Self

Authenticates with an API key sent in the cookie name.

pub fn description(self, description: impl Into<Cow<'static, str>>) -> Self

Explains how clients obtain and use the credentials.

pub fn bearer_format(self, format: impl Into<Cow<'static, str>>) -> Self

Names the format of a bearer token, such as JWT. This is a hint for readers and only applies to a bearer scheme.

Trait Implementations

impl Clone for SecurityScheme

fn clone(&self) -> Self

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