topcoat-openapi 0.12.1

A modular, batteries-included Rust web framework for server-rendered apps.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

use std::borrow::Cow;

use serde::Serialize;

/// A way for clients to authenticate, such as a bearer token or an API key.
///
/// Register it under a name with
/// [`OpenApi::security_scheme`](crate::OpenApi::security_scheme), then
/// require it with [`Operation::security`](crate::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");
/// ```
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct SecurityScheme {
    #[serde(rename = "type")]
    kind: &'static str,
    #[serde(skip_serializing_if = "Option::is_none")]
    description: Option<Cow<'static, str>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    name: Option<Cow<'static, str>>,
    #[serde(rename = "in", skip_serializing_if = "Option::is_none")]
    location: Option<&'static str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    scheme: Option<&'static str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    bearer_format: Option<Cow<'static, str>>,
}

impl SecurityScheme {
    /// Creates a scheme that uses the HTTP `Authorization` header with the
    /// given authentication scheme.
    fn http(scheme: &'static str) -> Self {
        Self {
            kind: "http",
            description: None,
            name: None,
            location: None,
            scheme: Some(scheme),
            bearer_format: None,
        }
    }

    /// Creates a scheme that sends an API key under `name` in `location`.
    fn api_key(location: &'static str, name: impl Into<Cow<'static, str>>) -> Self {
        Self {
            kind: "apiKey",
            description: None,
            name: Some(name.into()),
            location: Some(location),
            scheme: None,
            bearer_format: None,
        }
    }

    /// Authenticates with a token sent as `Authorization: Bearer <token>`.
    #[must_use]
    pub fn bearer() -> Self {
        Self::http("bearer")
    }

    /// Authenticates with a user name and password sent through HTTP basic
    /// authentication.
    #[must_use]
    pub fn basic() -> Self {
        Self::http("basic")
    }

    /// Authenticates with an API key sent in the request header `name`.
    #[must_use]
    pub fn api_key_header(name: impl Into<Cow<'static, str>>) -> Self {
        Self::api_key("header", name)
    }

    /// Authenticates with an API key sent as the query string key `name`.
    #[must_use]
    pub fn api_key_query(name: impl Into<Cow<'static, str>>) -> Self {
        Self::api_key("query", name)
    }

    /// Authenticates with an API key sent in the cookie `name`.
    #[must_use]
    pub fn api_key_cookie(name: impl Into<Cow<'static, str>>) -> Self {
        Self::api_key("cookie", name)
    }

    /// Explains how clients obtain and use the credentials.
    #[must_use]
    pub fn description(mut self, description: impl Into<Cow<'static, str>>) -> Self {
        self.description = Some(description.into());
        self
    }

    /// Names the format of a bearer token, such as `JWT`. This is a hint for
    /// readers and only applies to a [`bearer`](Self::bearer) scheme.
    #[must_use]
    pub fn bearer_format(mut self, format: impl Into<Cow<'static, str>>) -> Self {
        self.bearer_format = Some(format.into());
        self
    }
}