foxy-io 0.3.12

A configuration-driven and hyper-extensible HTTP proxy library
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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

//! Serves an embedded Swagger UI.
//!
//! This module is only available when the `swagger-ui` feature is enabled.
//! It serves a single HTML page that loads the Swagger UI assets from a CDN
//! and is configured dynamically based on the `swagger_ui` section in the
//! configuration file.

use bytes::Bytes;
use std::convert::Infallible;

#[cfg(test)]
#[path = "../../tests/unit/server/swagger_tests.rs"]
mod tests;

use hyper::{Request, Response, StatusCode, header};
use reqwest::Body;
use serde::{Deserialize, Serialize};

/// Configuration for a single Swagger source (API specification).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SwaggerSource {
    /// The name of the API, which will be displayed in the Swagger UI dropdown.
    pub name: String,
    /// The URL to the OpenAPI specification file (e.g., `/api/v1/openapi.json`).
    pub url: String,
}

/// Configuration for the Swagger UI feature.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SwaggerUIConfig {
    /// Whether the Swagger UI is enabled.
    #[serde(default)]
    pub enabled: bool,
    /// The base path under which the Swagger UI will be served (e.g., `/swagger-ui`).
    #[serde(default = "default_swagger_path")]
    pub path: String,
    /// A list of API sources to be displayed in the Swagger UI.
    #[serde(default)]
    pub sources: Vec<SwaggerSource>,
}

fn default_swagger_path() -> String {
    "/swagger-ui".to_string()
}

impl Default for SwaggerUIConfig {
    fn default() -> Self {
        Self {
            enabled: false,
            path: default_swagger_path(),
            sources: Vec::new(),
        }
    }
}

/// Generates the `urls` configuration array for Swagger UI.
fn generate_urls_config(sources: &[SwaggerSource]) -> String {
    if sources.is_empty() {
        return "[]".to_string();
    }
    let mut urls_json = String::from("[");
    for (i, source) in sources.iter().enumerate() {
        urls_json.push_str(&format!(
            "{{ url: \"{}\", name: \"{}\" }}",
            source.url, source.name
        ));
        if i < sources.len() - 1 {
            urls_json.push_str(", ");
        }
    }
    urls_json.push(']');
    urls_json
}

/// Generates the full HTML page for the Swagger UI.
fn generate_html(config: &SwaggerUIConfig) -> String {
    let urls_config = generate_urls_config(&config.sources);

    // Set the `url` parameter to the first source to ensure a default is loaded.
    let default_url = config.sources.first().map_or("", |s| &s.url);

    format!(
        r#"
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Foxy Swagger UI</title>
  <link rel="stylesheet" type="text/css" href="https://unpkg.com/swagger-ui-dist@5.24.0/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="https://unpkg.com/swagger-ui-dist@5.24.0/swagger-ui-bundle.js" charset="UTF-8" crossorigin></script>
  <script src="https://unpkg.com/swagger-ui-dist@5.24.0/swagger-ui-standalone-preset.js" crossorigin></script>
  <script>
      window.onload = () => {{
        window.ui = SwaggerUIBundle({{
            url: '{default_url}',
            urls: {urls_config},
            dom_id: '#swagger-ui',
            deepLinking: true,
            presets: [
              SwaggerUIBundle.presets.apis,
              SwaggerUIStandalonePreset
            ],
            layout: "StandaloneLayout",
        }});
      }};
  </script>
</body>
</html>
"#,
        default_url = default_url,
        urls_config = urls_config
    )
}

/// Handles incoming requests for the Swagger UI.
pub async fn handle_swagger_request<T>(
    req: &Request<T>,
    config: &SwaggerUIConfig,
) -> Result<Response<Body>, Infallible> {
    let path = req.uri().path();
    let root_path = &config.path;
    let index_path = format!("{}/index.html", root_path);

    // Serve the main HTML file for the root index path (with trailing slash) or index.html
    if path == *root_path || path == format!("{root_path}/") || path == index_path {
        let html = generate_html(config);
        return Ok(Response::builder()
            .status(StatusCode::OK)
            .header(header::CONTENT_TYPE, "text/html; charset=utf-8")
            .body(Body::from(Bytes::from(html)))
            .unwrap());
    }

    // For any other path under the swagger root, return 404
    Ok(Response::builder()
        .status(StatusCode::NOT_FOUND)
        .body(Body::from(Bytes::from("Not Found")))
        .unwrap())
}