hypers_openapi 0.14.1

Compile time generated OpenAPI documentation for hypers
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332

mod config;
mod oauth;

pub use config::Config;
use hypers_core::{
    async_trait,
    prelude::{Request, Response},
    fs::redirect_to_dir_url, Handler,
};
pub use oauth::OauthConfig;
use rust_embed::RustEmbed;
use serde::Serialize;
use std::borrow::Cow;

#[derive(RustEmbed)]
#[folder = "src/swagger_ui/v5.17.14"]
struct SwaggerUiDist;

const INDEX_TMPL: &str = r#"
<!DOCTYPE html>
<html charset="UTF-8">
  <head>
    <meta charset="UTF-8">
    <title>{{title}}</title>
    {{keywords}}
    {{description}}
    <link rel="stylesheet" type="text/css" href="./swagger-ui.css" />
    <style>
    html {
        box-sizing: border-box;
        overflow: -moz-scrollbars-vertical;
        overflow-y: scroll;
    }
    *,
    *:before,
    *:after {
        box-sizing: inherit;
    }
    body {
        margin: 0;
        background: #fafafa;
    }
    </style>
  </head>

  <body>
    <div id="swagger-ui"></div>
    <script src="./swagger-ui-bundle.js" charset="UTF-8"></script>
    <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"></script>
    <script>
    window.onload = function() {
        let config = {
            dom_id: '#swagger-ui',
            deepLinking: true,
            presets: [
              SwaggerUIBundle.presets.apis,
              SwaggerUIStandalonePreset
            ],
            plugins: [
              SwaggerUIBundle.plugins.DownloadUrl
            ],
            layout: "StandaloneLayout"
          };
        window.ui = SwaggerUIBundle(Object.assign(config, {{config}}));
        //{{oauth}}
    };
    </script>
  </body>
</html>
"#;
/// Represents servable file of Swagger UI. This is used together with [`serve`] function
/// to serve Swagger UI files via web server.
#[non_exhaustive]
pub struct SwaggerFile<'a> {
    /// Content of the file as [`Cow`] [`slice`] of bytes.
    pub bytes: Cow<'a, [u8]>,
    /// Content type of the file e.g `"text/xml"`.
    pub content_type: String,
}
/// Implements [`Handler`] for serving Swagger UI.
#[derive(Clone, Debug)]
pub struct SwaggerUi {
    pub config: Config<'static>,
    /// The title of the html page. The default title is "Swagger UI".
    pub title: Cow<'static, str>,
    /// The keywords of the html page.
    pub keywords: Option<Cow<'static, str>>,
    /// The description of the html page.
    pub description: Option<Cow<'static, str>>,
}
impl SwaggerUi {
    /// Create a new [`SwaggerUi`] for given path.
    /// Path argument will expose the Swagger UI to the user and should be something that
    /// the underlying application framework / library supports.
    /// # Examples
    /// ```rust
    /// # use hypers_openapi::swagger_ui::SwaggerUi;
    /// let swagger = SwaggerUi::new("/swagger-ui/{_:.*}");
    /// ```
    pub fn new(config: impl Into<Config<'static>>) -> Self {
        Self {
            config: config.into(),
            title: "Swagger UI".into(),
            keywords: None,
            description: None,
        }
    }
    /// Set title of the html page. The default title is "Swagger UI".
    pub fn title(mut self, title: impl Into<Cow<'static, str>>) -> Self {
        self.title = title.into();
        self
    }
    /// Set keywords of the html page.
    pub fn keywords(mut self, keywords: impl Into<Cow<'static, str>>) -> Self {
        self.keywords = Some(keywords.into());
        self
    }
    /// Set description of the html page.
    pub fn description(mut self, description: impl Into<Cow<'static, str>>) -> Self {
        self.description = Some(description.into());
        self
    }
    /// Add api doc [`Url`] into [`SwaggerUi`].
    /// Calling this again will add another url to the Swagger UI.
    /// # Examples
    /// ```rust
    /// # use hypers_openapi::swagger_ui::SwaggerUi;
    /// # use hypers_openapi::OpenApi;
    /// let swagger = SwaggerUi::new("/api-doc/openapi.json")
    ///     .url("/api-docs/openapi2.json");
    /// ```
    pub fn url<U: Into<Url<'static>>>(mut self, url: U) -> Self {
        self.config.urls.push(url.into());
        self
    }
    /// Add multiple [`Url`]s to Swagger UI.
    /// Takes one [`Vec`] argument containing tuples of [`Url`] and [OpenApi][crate::OpenApi].
    /// Situations where this comes handy is when there is a need or wish to separate different parts
    /// of the api to separate api docs.
    /// # Examples
    /// Expose multiple api docs via Swagger UI.
    /// ```rust
    /// # use hypers_openapi::swagger_ui::{SwaggerUi, Url};
    /// # use hypers_openapi::OpenApi;
    /// let swagger = SwaggerUi::new("/swagger-ui/{_:.*}")
    ///     .urls(
    ///       vec![
    ///          (Url::with_primary("api doc 1", "/api-docs/openapi.json", true)),
    ///          (Url::new("api doc 2", "/api-docs/openapi2.json"))
    ///     ]
    /// );
    /// ```
    pub fn urls(mut self, urls: Vec<Url<'static>>) -> Self {
        self.config.urls = urls;
        self
    }
    /// Add oauth [`oauth::Config`] into [`SwaggerUi`].
    /// Method takes one argument which exposes the [`oauth::Config`] to the user.
    /// # Examples
    /// Enable pkce with default client_id.
    /// ```rust
    /// # use hypers_openapi::swagger_ui::{SwaggerUi, OauthConfig};
    /// # use hypers_openapi::OpenApi;
    /// let swagger = SwaggerUi::new("/swagger-ui/{_:.*}")
    ///     .url("/api-docs/openapi.json")
    ///     .oauth(OauthConfig::new()
    ///         .client_id("client-id")
    ///         .scopes(vec![String::from("openid")])
    ///         .use_pkce_with_authorization_code_grant(true)
    ///     );
    /// ```
    pub fn oauth(mut self, oauth: oauth::OauthConfig) -> Self {
        self.config.oauth = Some(oauth);
        self
    }
    pub fn serve<'a>(
        path: &str,
        title: &str,
        keywords: &str,
        description: &str,
        config: &Config<'a>,
    ) -> Result<Option<SwaggerFile<'a>>, serde_json::Error> {
        let path = if path.is_empty() || path == "/" {
            "index.html"
        } else {
            path
        };
        let bytes = if path == "index.html" {
            let config_json = serde_json::to_string(&config)?;
            // Replace {{config}} with pretty config json and remove the curly brackets `{ }` from beginning and the end.
            let mut index = INDEX_TMPL
                .replacen("{{config}}", &config_json, 1)
                .replacen("{{description}}", description, 1)
                .replacen("{{keywords}}", keywords, 1)
                .replacen("{{title}}", title, 1);
            if let Some(oauth) = &config.oauth {
                let oauth_json = serde_json::to_string(oauth)?;
                index = index.replace(
                    "//{{oauth}}",
                    &format!("window.ui.initOAuth({});", &oauth_json),
                );
            }
            Some(Cow::Owned(index.as_bytes().to_vec()))
        } else {
            SwaggerUiDist::get(path).map(|f| f.data)
        };
        let file = bytes.map(|bytes| SwaggerFile {
            bytes,
            content_type: mime_guess::from_path(path)
                .first_or_octet_stream()
                .to_string(),
        });
        Ok(file)
    }
}
/// Rust type for Swagger UI url configuration object.
#[non_exhaustive]
#[derive(Default, Serialize, Clone, Debug)]
pub struct Url<'a> {
    name: Cow<'a, str>,
    url: Cow<'a, str>,
    #[serde(skip)]
    primary: bool,
}
impl<'a> Url<'a> {
    /// Create new [`Url`].
    /// Name is shown in the select dropdown when there are multiple docs in Swagger UI.
    /// Url is path which exposes the OpenAPI doc.
    /// # Examples
    /// ```rust
    /// # use hypers_openapi::swagger_ui::Url;
    /// let url = Url::new("My Api", "/api-docs/openapi.json");
    /// ```
    pub fn new(name: &'a str, url: &'a str) -> Self {
        Self {
            name: Cow::Borrowed(name),
            url: Cow::Borrowed(url),
            ..Default::default()
        }
    }
    /// Create new [`Url`] with primary flag.
    /// Primary flag allows users to override the default behavior of the Swagger UI for selecting the primary
    /// doc to display. By default when there are multiple docs in Swagger UI the first one in the list
    /// will be the primary.
    /// Name is shown in the select dropdown when there are multiple docs in Swagger UI.
    /// Url is path which exposes the OpenAPI doc.
    /// # Examples
    /// Set "My Api" as primary.
    /// ```rust
    /// # use hypers_openapi::swagger_ui::Url;
    /// let url = Url::with_primary("My Api", "/api-docs/openapi.json", true);
    /// ```
    pub fn with_primary(name: &'a str, url: &'a str, primary: bool) -> Self {
        Self {
            name: Cow::Borrowed(name),
            url: Cow::Borrowed(url),
            primary,
        }
    }
}
impl<'a> From<&'a str> for Url<'a> {
    fn from(url: &'a str) -> Self {
        Self {
            url: Cow::Borrowed(url),
            ..Default::default()
        }
    }
}
impl From<String> for Url<'_> {
    fn from(url: String) -> Self {
        Self {
            url: Cow::Owned(url),
            ..Default::default()
        }
    }
}
impl<'a> From<Cow<'static, str>> for Url<'a> {
    fn from(url: Cow<'static, str>) -> Self {
        Self {
            url,
            ..Default::default()
        }
    }
}
#[async_trait]
impl Handler for SwaggerUi {
    #[inline]
    async fn handle(&self, req: Request) -> Response {
        let path = req.param::<&str>("*1").map(|s| s.trim_start_matches('/'));
        let mut res = Response::default();
        if path.is_err() && !req.uri().path().ends_with('/') {
            return redirect_to_dir_url(req.uri(), res);
        }
        let keywords = self
            .keywords
            .as_ref()
            .map(|s| {
                format!(
                    "<meta name=\"keywords\" content=\"{}\">",
                    s.split(',').map(|s| s.trim()).collect::<Vec<_>>().join(",")
                )
            })
            .unwrap_or_default();
        let description = self
            .description
            .as_ref()
            .map(|s| format!("<meta name=\"description\" content=\"{}\">", s))
            .unwrap_or_default();
        match SwaggerUi::serve(
            path.unwrap(),
            &self.title,
            &keywords,
            &description,
            &self.config,
        ) {
            Ok(Some(file)) => {
                res.content_type(&file.content_type)
                    .body(file.bytes.to_vec());
                res
            }
            Ok(None) => {
                res.status(500);
                res
            }
            Err(e) => {
                res.status(500).body(e.to_string());
                res
            }
        }
    }
}
//v0.67.2 => crates/openapi/src/swagger_ui/v5.13.0