openapi-ui 0.2.0

A Rust library for generating custom UI for OpenAPI/Swagger documentation.
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

//! HTML template rendering for the documentation UI.

use crate::openapi::OpenAPISpec;
use crate::theme;

/// The raw HTML template used for rendering.
pub const TEMPLATE_HTML: &str = include_str!("index.html");

const SAMPLE_DATA: &str = include_str!("sample_data.json");

/// Renders the HTML template with the given spec, theme, and favicon.
pub fn template(spec: &OpenAPISpec, theme_name: &str, favicon: &str) -> String {
    let spec_json = serde_json::to_string(spec).unwrap_or_default();
    let js_string = serde_json::to_string(&spec_json).unwrap_or_default();
    let sample_data_js = serde_json::to_string(SAMPLE_DATA).unwrap_or_default();

    let mode = theme_name.parse().unwrap_or(theme::ThemeMode::System);

    TEMPLATE_HTML
        .replace("{{light}}", &theme::ThemeMode::Light.get_css())
        .replace("{{dark}}", &theme::ThemeMode::Dark.get_css())
        .replace("{{theme}}", mode.as_str())
        .replace("{{favicon}}", favicon)
        .replace("/* SPEC_JSON_PLACEHOLDER */ null", &js_string)
        .replace("/* SAMPLE_DATA_PLACEHOLDER */ null", &sample_data_js)
}

/// Renders the HTML template with optional custom CSS injected after the built-in themes.
pub fn template_with_custom_theme(
    spec: &OpenAPISpec,
    theme_name: &str,
    custom_css: Option<&str>,
    favicon: &str,
) -> String {
    let spec_json = serde_json::to_string(spec).unwrap_or_default();
    let js_string = serde_json::to_string(&spec_json).unwrap_or_default();
    let sample_data_js = serde_json::to_string(SAMPLE_DATA).unwrap_or_default();

    let mode = theme_name.parse().unwrap_or(theme::ThemeMode::System);
    let inject_theme_script = mode == theme::ThemeMode::System;

    // Inline script to set theme before page renders (prevents flash of wrong theme)
    let theme_script = if inject_theme_script {
        r#"<script>(function(){var t=localStorage.getItem("apidocs-theme");if(!t||t==="system"){t=window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light"}document.documentElement.setAttribute("data-theme",t)})()</script>"#
    } else {
        ""
    };

    let light_content = theme::ThemeMode::Light.get_css();
    let dark_content = theme::ThemeMode::Dark.get_css();

    let mut html = TEMPLATE_HTML
        .replace("{{light}}", &light_content)
        .replace("{{dark}}", &dark_content)
        .replace("{{theme}}", mode.as_str())
        .replace("{{favicon}}", favicon)
        .replace("/* SPEC_JSON_PLACEHOLDER */ null", &js_string)
        .replace("/* SAMPLE_DATA_PLACEHOLDER */ null", &sample_data_js);

    if inject_theme_script {
        html = html.replace("<head>", &format!("<head>\n        {}", theme_script));
    }

    if let Some(css) = custom_css {
        html = html.replace("</head>", &format!("<style>{}</style></head>", css));
    }

    html
}

/// Renders a demo template using the built-in Petstore sample data.
pub fn base_template() -> String {
    let sample_data_js = serde_json::to_string(SAMPLE_DATA).unwrap_or_default();

    TEMPLATE_HTML
        .replace("{{light}}", &theme::ThemeMode::Light.get_css())
        .replace("{{dark}}", &theme::ThemeMode::Dark.get_css())
        .replace("{{theme}}", "system")
        .replace(
            "{{favicon}}",
            "https://www.openapis.org/wp-content/uploads/sites/31/2019/06/favicon-140x140.png",
        )
        .replace("/* SPEC_JSON_PLACEHOLDER */ null", "null")
        .replace("/* SAMPLE_DATA_PLACEHOLDER */ null", &sample_data_js)
}

/// Renders the HTML template with embedded theme CSS.
pub fn template_with_embedded_theme(spec: &OpenAPISpec, theme_name: &str, favicon: &str) -> String {
    let spec_json = serde_json::to_string(spec).unwrap_or_default();
    let js_string = serde_json::to_string(&spec_json).unwrap_or_default();
    let sample_data_js = serde_json::to_string(SAMPLE_DATA).unwrap_or_default();

    let mode = theme_name.parse().unwrap_or(theme::ThemeMode::System);

    TEMPLATE_HTML
        .replace("{{light}}", &theme::ThemeMode::Light.get_css())
        .replace("{{dark}}", &theme::ThemeMode::Dark.get_css())
        .replace("{{theme}}", mode.as_str())
        .replace("{{favicon}}", favicon)
        .replace("/* SPEC_JSON_PLACEHOLDER */ null", &js_string)
        .replace("/* SAMPLE_DATA_PLACEHOLDER */ null", &sample_data_js)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::openapi::{Info, OpenAPISpec};
    use std::collections::HashMap;

    #[test]
    fn test_template_generation() {
        let spec = OpenAPISpec {
            openapi: "3.0.0".to_string(),
            info: Info {
                title: "Test API".to_string(),
                version: "1.0.0".to_string(),
                description: Some("A test API".to_string()),
                terms_of_service: None,
                contact: None,
                license: None,
                x_logo: None,
            },
            servers: vec![],
            paths: HashMap::new(),
            components: None,
            security: None,
            tags: None,
            external_docs: None,
        };

        let html = template(&spec, "dark", "favicon.ico");
        assert!(html.contains("Test API"));
        assert!(html.contains("3.0.0"));
        assert!(html.contains("<!doctype html>"));
    }

    #[test]
    fn test_template_with_custom_theme() {
        let spec = OpenAPISpec {
            openapi: "3.0.0".to_string(),
            info: Info {
                title: "Custom Theme API".to_string(),
                version: "1.0.0".to_string(),
                description: None,
                terms_of_service: None,
                contact: None,
                license: None,
                x_logo: None,
            },
            servers: vec![],
            paths: HashMap::new(),
            components: None,
            security: None,
            tags: None,
            external_docs: None,
        };

        let custom_css = ":root { --accent: #ff0000; }";
        let html = template_with_custom_theme(&spec, "light", Some(custom_css), "favicon.ico");
        assert!(html.contains("Custom Theme API"));
    }

    #[test]
    fn test_template_with_system_theme_injects_script() {
        let spec = OpenAPISpec {
            openapi: "3.0.0".to_string(),
            info: Info {
                title: "System Theme API".to_string(),
                version: "1.0.0".to_string(),
                description: None,
                terms_of_service: None,
                contact: None,
                license: None,
                x_logo: None,
            },
            servers: vec![],
            paths: HashMap::new(),
            components: None,
            security: None,
            tags: None,
            external_docs: None,
        };

        let html = template_with_custom_theme(&spec, "system", None, "favicon.ico");
        assert!(html.contains("apidocs-theme"));
        assert!(html.contains("prefers-color-scheme"));
        assert!(html.contains("data-theme=\"system\""));
    }

    #[test]
    fn test_system_theme_script_content() {
        let spec = OpenAPISpec {
            openapi: "3.0.0".to_string(),
            info: Info {
                title: "Test".to_string(),
                version: "1.0.0".to_string(),
                description: None,
                terms_of_service: None,
                contact: None,
                license: None,
                x_logo: None,
            },
            servers: vec![],
            paths: HashMap::new(),
            components: None,
            security: None,
            tags: None,
            external_docs: None,
        };

        let html = template_with_custom_theme(&spec, "system", None, "favicon.ico");

        assert!(html.contains("localStorage.getItem(\"apidocs-theme\")"));
        assert!(html.contains("matchMedia(\"(prefers-color-scheme: dark)\")"));

        assert!(html.contains("if(!t||t===\"system\")"));

        assert!(html.contains("setAttribute(\"data-theme\",t)"));
    }

    #[test]
    fn test_base_template() {
        let html = base_template();
        assert!(html.contains("<!doctype html>"));
        assert!(html.contains("<html"));
        assert!(html.contains("INJECTED_SPEC"));
    }

    #[test]
    fn test_template_with_embedded_theme() {
        let spec = OpenAPISpec {
            openapi: "3.0.0".to_string(),
            info: Info {
                title: "Embedded Theme API".to_string(),
                version: "1.0.0".to_string(),
                description: None,
                terms_of_service: None,
                contact: None,
                license: None,
                x_logo: None,
            },
            servers: vec![],
            paths: HashMap::new(),
            components: None,
            security: None,
            tags: None,
            external_docs: None,
        };

        let html = template_with_embedded_theme(&spec, "dark", "favicon.ico");
        assert!(html.contains("Embedded Theme API"));
        assert!(html.contains("<!doctype html>"));
    }
}