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 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
//! This crate implements necessary boiler plate code to serve Swagger UI via web server. It
//! works as a bridge for serving the OpenAPI documentation created with [`salvo`][salvo] library in the
//! Swagger UI.
//!
//! [salvo]: <https://docs.rs/salvo/>
//!
use std::borrow::Cow;
mod config;
pub mod oauth;
use crate::OpenApi;
pub use config::Config;
use rust_embed::RustEmbed;
use salvo_core::http::uri::{Parts as UriParts, Uri};
use salvo_core::http::{header, HeaderValue, ResBody, StatusError};
use salvo_core::writing::Redirect;
use salvo_core::{async_trait, Depot, Error, FlowCtrl, Handler, Request, Response, Router};
use serde::Serialize;
#[derive(RustEmbed)]
#[folder = "src/swagger_ui/v5.2.0"]
struct SwaggerUiDist;
const INDEX_TMPL: &str = r#"
<!DOCTYPE html>
<html charset="UTF-8">
<head>
<meta charset="UTF-8">
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="./swagger-ui.css" />
<link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
<link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
<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>
"#;
/// Implements [`Handler`] for serving Swagger UI.
#[derive(Clone, Debug)]
pub struct SwaggerUi {
urls: Vec<(Url<'static>, OpenApi)>,
config: Config<'static>,
external_urls: Vec<(Url<'static>, serde_json::Value)>,
}
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 salvo_oapi::swagger_ui::SwaggerUi;
/// let swagger = SwaggerUi::new("/swagger-ui/{_:.*}");
/// ```
pub fn new(config: impl Into<Config<'static>>) -> Self {
Self {
urls: Vec::new(),
config: config.into(),
external_urls: Vec::new(),
}
}
/// Add api doc [`Url`] into [`SwaggerUi`].
///
/// Method takes two arguments where first one is path which exposes the [`OpenApi`] to the user.
/// Second argument is the actual Rust implementation of the OpenAPI doc which is being exposed.
///
/// Calling this again will add another url to the Swagger UI.
///
/// # Examples
///
/// ```rust
/// # use salvo_oapi::swagger_ui::SwaggerUi;
/// # use salvo_oapi::OpenApi;
///
/// let swagger = SwaggerUi::new("/api-doc/openapi.json")
/// .url("/api-docs/openapi2.json", OpenApi::new("example api", "0.0.1"));
/// ```
pub fn url<U: Into<Url<'static>>>(mut self, url: U, openapi: OpenApi) -> Self {
self.urls.push((url.into(), openapi));
self
}
/// Add multiple [`Url`]s to Swagger UI.
///
/// Takes one [`Vec`] argument containing tuples of [`Url`] and [`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 salvo_oapi::swagger_ui::{SwaggerUi, Url};
/// # use salvo_oapi::OpenApi;
///
/// let swagger = SwaggerUi::new("/swagger-ui/{_:.*}")
/// .urls(
/// vec![
/// (Url::with_primary("api doc 1", "/api-docs/openapi.json", true), OpenApi::new("example api", "0.0.1")),
/// (Url::new("api doc 2", "/api-docs/openapi2.json"), OpenApi::new("example api2", "0.0.1"))
/// ]
/// );
/// ```
pub fn urls(mut self, urls: Vec<(Url<'static>, OpenApi)>) -> Self {
self.urls = urls;
self
}
/// Add external API doc to the [`SwaggerUi`].
///
/// This operation is unchecked and so it does not check any validity of provided content.
/// Users are required to do their own check if any regarding validity of the external
/// OpenAPI document.
///
/// Method accepts two arguments, one is [`Url`] the API doc is served at and the second one is
/// the [`serde_json::Value`] of the OpenAPI doc to be served.
///
/// # Examples
///
/// Add external API doc to the [`SwaggerUi`].
///```rust
/// # use salvo_oapi::swagger_ui::{SwaggerUi, Url};
/// # use salvo_oapi::OpenApi;
/// # use serde_json::json;
/// let external_openapi = json!({"openapi": "3.0.0"});
///
/// let swagger = SwaggerUi::new("/swagger-ui/{_:.*}")
/// .external_url_unchecked("/api-docs/openapi.json", external_openapi);
///```
pub fn external_url_unchecked<U: Into<Url<'static>>>(mut self, url: U, openapi: serde_json::Value) -> Self {
self.external_urls.push((url.into(), openapi));
self
}
/// Add external API docs to the [`SwaggerUi`] from iterator.
///
/// This operation is unchecked and so it does not check any validity of provided content.
/// Users are required to do their own check if any regarding validity of the external
/// OpenAPI documents.
///
/// Method accepts one argument, an `iter` of [`Url`] and [`serde_json::Value`] tuples. The
/// [`Url`] will point to location the OpenAPI document is served and the [`serde_json::Value`]
/// is the OpenAPI document to be served.
///
/// # Examples
///
/// Add external API docs to the [`SwaggerUi`].
///```rust
/// # use salvo_oapi::swagger_ui::{SwaggerUi, Url};
/// # use salvo_oapi::OpenApi;
/// # use serde_json::json;
/// let external_openapi = json!({"openapi": "3.0.0"});
/// let external_openapi2 = json!({"openapi": "3.0.0"});
///
/// let swagger = SwaggerUi::new("/swagger-ui/{_:.*}")
/// .external_urls_from_iter_unchecked([
/// ("/api-docs/openapi.json", external_openapi),
/// ("/api-docs/openapi2.json", external_openapi2)
/// ]);
///```
pub fn external_urls_from_iter_unchecked<I: IntoIterator<Item = (U, serde_json::Value)>, U: Into<Url<'static>>>(
mut self,
external_urls: I,
) -> Self {
self.external_urls
.extend(external_urls.into_iter().map(|(url, doc)| (url.into(), doc)));
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 salvo_oapi::swagger_ui::{SwaggerUi, oauth};
/// # use salvo_oapi::OpenApi;
///
/// let swagger = SwaggerUi::new("/swagger-ui/{_:.*}")
/// .url("/api-docs/openapi.json", OpenApi::new("example api", "0.0.1"))
/// .oauth(oauth::Config::new()
/// .client_id("client-id")
/// .scopes(vec![String::from("openid")])
/// .use_pkce_with_authorization_code_grant(true)
/// );
/// ```
pub fn oauth(mut self, oauth: oauth::Config) -> Self {
self.config.oauth = Some(oauth);
self
}
/// Consusmes the [`SwaggerUi`] and returns [`Router`] with the [`SwaggerUi`] as handler.
pub fn into_router(self, path: impl Into<String>) -> Router {
Router::with_path(format!("{}/<**>", path.into())).handle(self)
}
}
#[inline]
pub(crate) fn redirect_to_dir_url(req_uri: &Uri, res: &mut Response) {
let UriParts {
scheme,
authority,
path_and_query,
..
} = req_uri.clone().into_parts();
let mut builder = Uri::builder();
if let Some(scheme) = scheme {
builder = builder.scheme(scheme);
}
if let Some(authority) = authority {
builder = builder.authority(authority);
}
if let Some(path_and_query) = path_and_query {
if let Some(query) = path_and_query.query() {
builder = builder.path_and_query(format!("{}/?{}", path_and_query.path(), query));
} else {
builder = builder.path_and_query(format!("{}/", path_and_query.path()));
}
}
let redirect_uri = builder.build().unwrap();
res.render(Redirect::found(redirect_uri));
}
#[async_trait]
impl Handler for SwaggerUi {
async fn handle(&self, req: &mut Request, _depot: &mut Depot, res: &mut Response, _ctrl: &mut FlowCtrl) {
let path = req.params().get("**").map(|s| &**s).unwrap_or_default();
// Redirect to dir url if path is empty and not end with '/'
if path.is_empty() && !req.uri().path().ends_with('/') {
redirect_to_dir_url(req.uri(), res);
return;
}
match serve(path, &self.config) {
Ok(Some(file)) => {
res.headers_mut()
.insert(header::CONTENT_TYPE, HeaderValue::from_str(&file.content_type).unwrap());
res.body(ResBody::Once(file.bytes.to_vec().into()));
}
Ok(None) => {
tracing::warn!(path = path, "swagger ui file not found");
res.render(StatusError::not_found());
}
Err(e) => {
tracing::error!(error = ?e, path = path, "failed to fetch swagger ui file");
res.render(StatusError::internal_server_error());
}
}
}
}
/// 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 salvo_oapi::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 salvo_oapi::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()
}
}
}
/// 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,
}
/// User friendly way to serve Swagger UI and its content via web server.
///
/// * **path** Should be the relative path to Swagger UI resource within the web server.
/// * **config** Swagger [`Config`] to use for the Swagger UI.
///
/// Typically this function is implemented _**within**_ handler what serves the Swagger UI. Handler itself must
/// match to user defined path that points to the root of the Swagger UI and match everything relatively
/// from the root of the Swagger UI _**(tail path)**_. The relative path from root of the Swagger UI
/// is used to serve [`SwaggerFile`]s. If Swagger UI is served from path `/swagger-ui/` then the `tail`
/// is everything under the `/swagger-ui/` prefix.
///
/// _There are also implementations in [examples of salvo repository][examples]._
///
/// [examples]: https://github.com/salvo-rs/salvo/tree/master/examples
pub fn serve<'a>(path: &str, config: &Config<'a>) -> Result<Option<SwaggerFile<'a>>, 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.replace("{{config}}", &config_json);
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)
}