Struct ApiKeyConfig 

pub struct ApiKeyConfig {
    pub name: String,
    pub location: ApiKeyLocation,
    pub description: Option<String>,
}

Configuration for API key extraction.

Fields

name: String

Name of the header/query param/cookie.

location: ApiKeyLocation

Where to look for the API key.

description: Option<String>

Description for OpenAPI documentation.

Implementations

impl ApiKeyConfig

pub fn header(name: impl Into<String>) -> Self

Create a config for header-based API key.

pub fn query(name: impl Into<String>) -> Self

Create a config for query-based API key.

pub fn cookie(name: impl Into<String>) -> Self

Create a config for cookie-based API key.

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

Set description for OpenAPI.

Trait Implementations

impl Clone for ApiKeyConfig

fn clone(&self) -> ApiKeyConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKeyConfig

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

Formats the value using the given formatter.

impl Default for ApiKeyConfig

fn default() -> Self

Returns the “default value” for a type.