sz-orm-swagger 1.0.0

OpenAPI/Swagger spec generator: path/method/parameter/response builder, self-contained Swagger UI HTML rendering
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

//! # SZ-ORM Swagger — OpenAPI/Swagger 规范生成
//!
//! 提供 OpenAPI 3.0 规范的构建与序列化，支持路径、方法、参数与响应定义，
//! 输出可被 Swagger UI 等工具直接消费。
//!
//! ## 主要类型
//!
//! - [`OpenAPISpec`] — 规范根对象
//! - [`PathInfo`] — 单个 (path, method) 操作描述

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct OpenAPISpec {
    pub paths: HashMap<String, serde_json::Value>,
    pub info: serde_json::Value,
}

impl OpenAPISpec {
    pub fn to_json_string(&self) -> String {
        serde_json::to_string_pretty(self).unwrap_or_else(|_| "{}".to_string())
    }
}

/// Describes a single (path, method) operation in an OpenAPI spec.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PathInfo {
    pub method: String,
    pub summary: String,
    pub parameters: Vec<serde_json::Value>,
    pub responses: HashMap<String, serde_json::Value>,
}

impl PathInfo {
    pub fn new(method: &str, summary: &str) -> Self {
        Self {
            method: method.to_string(),
            summary: summary.to_string(),
            parameters: vec![],
            responses: HashMap::new(),
        }
    }

    pub fn with_response(mut self, code: &str, desc: &str) -> Self {
        self.responses
            .insert(code.to_string(), serde_json::json!({ "description": desc }));
        self
    }

    pub fn with_parameter(mut self, param: serde_json::Value) -> Self {
        self.parameters.push(param);
        self
    }
}

pub struct OpenAPIGenerator {
    paths: Vec<(String, PathInfo)>,
    info: serde_json::Value,
}

impl OpenAPIGenerator {
    pub fn new() -> Self {
        Self {
            paths: vec![],
            info: serde_json::json!({
                "title": "API",
                "version": "1.0.0",
                "description": "Generated by sz-orm-swagger"
            }),
        }
    }

    pub fn with_info(mut self, info: serde_json::Value) -> Self {
        self.info = info;
        self
    }

    /// Register a (path, method) operation. Multiple methods on the same path
    /// are merged into a single paths entry.
    pub fn register_path(&mut self, path: &str, info: PathInfo) -> &mut Self {
        self.paths.push((path.to_string(), info));
        self
    }

    /// Generate an OpenAPISpec from the registered paths.
    pub fn generate(&self) -> OpenAPISpec {
        let mut paths: HashMap<String, serde_json::Value> = HashMap::new();
        for (path, info) in &self.paths {
            let method = info.method.to_lowercase();
            let entry = paths
                .entry(path.clone())
                .or_insert_with(|| serde_json::json!({}));
            entry[method] = serde_json::json!({
                "summary": info.summary,
                "parameters": info.parameters,
                "responses": info.responses
            });
        }
        OpenAPISpec {
            paths,
            info: self.info.clone(),
        }
    }
}

impl Default for OpenAPIGenerator {
    fn default() -> Self {
        Self::new()
    }
}

pub struct SwaggerUi {
    mount_path: String,
    spec: Option<OpenAPISpec>,
}

impl SwaggerUi {
    pub fn new(path: &str) -> Self {
        Self {
            mount_path: path.to_string(),
            spec: None,
        }
    }

    pub fn with_spec(mut self, spec: OpenAPISpec) -> Self {
        self.spec = Some(spec);
        self
    }

    pub fn mount(&self) -> String {
        format!("{}docs", self.mount_path)
    }

    /// Render a real, self-contained Swagger UI HTML page that loads the
    /// swagger-ui-dist CDN assets and embeds the spec JSON inline.
    pub fn render_html(&self) -> String {
        let spec_json = match &self.spec {
            Some(s) => s.to_json_string(),
            None => serde_json::json!({
                "openapi": "3.0.0",
                "info": { "title": "API", "version": "1.0.0" },
                "paths": {}
            })
            .to_string(),
        };
        let mount = self.mount();
        format!(
            r#"<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Swagger UI</title>
    <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@4.19.0/swagger-ui.css">
</head>
<body>
    <div id="swagger-ui"></div>
    <script src="https://unpkg.com/swagger-ui-dist@4.19.0/swagger-ui-bundle.js"></script>
    <script src="https://unpkg.com/swagger-ui-dist@4.19.0/swagger-ui-standalone-preset.js"></script>
    <script>
        const spec = {spec};
        window.onload = () => {{
            SwaggerUIBundle({{
                spec: spec,
                dom_id: '#swagger-ui',
                url: '{mount}/openapi.json',
                presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
                layout: 'StandaloneLayout'
            }});
        }};
    </script>
</body>
</html>"#,
            spec = spec_json,
            mount = mount
        )
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_gen_empty_has_no_paths() {
        let s = OpenAPIGenerator::new().generate();
        assert!(s.paths.is_empty());
        // Info should still be present
        assert_eq!(s.info["title"], "API");
    }

    #[test]
    fn test_register_and_generate_single_path() {
        let mut g = OpenAPIGenerator::new();
        g.register_path(
            "/users",
            PathInfo::new("GET", "List users").with_response("200", "OK"),
        );
        let spec = g.generate();
        let users = spec.paths.get("/users").expect("/users should exist");
        let get = users.get("get").expect("GET method should exist");
        assert_eq!(get["summary"], "List users");
        assert!(get["responses"]["200"].is_object());
    }

    #[test]
    fn test_register_multiple_methods_same_path() {
        let mut g = OpenAPIGenerator::new();
        g.register_path(
            "/users",
            PathInfo::new("GET", "List users").with_response("200", "OK"),
        );
        g.register_path(
            "/users",
            PathInfo::new("POST", "Create user").with_response("201", "Created"),
        );
        let spec = g.generate();
        assert_eq!(spec.paths.len(), 1, "only one /users path key");
        let users = spec.paths.get("/users").unwrap();
        assert!(users.get("get").is_some());
        assert!(users.get("post").is_some());
        assert_eq!(users["get"]["summary"], "List users");
        assert_eq!(users["post"]["summary"], "Create user");
        assert_eq!(users["post"]["responses"]["201"]["description"], "Created");
    }

    #[test]
    fn test_register_multiple_paths() {
        let mut g = OpenAPIGenerator::new();
        g.register_path("/users", PathInfo::new("GET", "List users"));
        g.register_path("/orders", PathInfo::new("GET", "List orders"));
        g.register_path(
            "/items/{id}",
            PathInfo::new("GET", "Get item").with_response("404", "Not found"),
        );
        let spec = g.generate();
        assert_eq!(spec.paths.len(), 3);
        assert!(spec.paths.contains_key("/users"));
        assert!(spec.paths.contains_key("/orders"));
        assert!(spec.paths.contains_key("/items/{id}"));
    }

    #[test]
    fn test_ui_mount() {
        let ui = SwaggerUi::new("/api");
        assert_eq!(ui.mount(), "/apidocs");
    }

    #[test]
    fn test_ui_html_contains_cdn_and_bundle() {
        let ui = SwaggerUi::new("/api").with_spec(OpenAPIGenerator::new().generate());
        let html = ui.render_html();
        assert!(html.contains("swagger-ui-dist"));
        assert!(html.contains("swagger-ui.css"));
        assert!(html.contains("swagger-ui-bundle.js"));
        assert!(html.contains("SwaggerUIBundle"));
        assert!(html.contains("id=\"swagger-ui\""));
        assert!(html.contains("<!DOCTYPE html>"));
    }

    #[test]
    fn test_ui_html_embeds_spec_content() {
        let mut g = OpenAPIGenerator::new();
        g.register_path(
            "/items",
            PathInfo::new("GET", "List items").with_response("200", "OK"),
        );
        let ui = SwaggerUi::new("/api").with_spec(g.generate());
        let html = ui.render_html();
        // Spec content should be embedded inline
        assert!(html.contains("/items"));
        assert!(html.contains("List items"));
        assert!(html.contains("\"get\""));
    }

    #[test]
    fn test_ui_html_without_spec_uses_default_spec() {
        let ui = SwaggerUi::new("/api");
        let html = ui.render_html();
        // Default spec should still produce valid HTML with a basic spec
        assert!(html.contains("swagger-ui"));
        assert!(html.contains("\"openapi\""));
    }

    #[test]
    fn test_spec_to_json_string_is_valid_json() {
        let mut g = OpenAPIGenerator::new();
        g.register_path("/users", PathInfo::new("GET", "List users"));
        let spec = g.generate();
        let json = spec.to_json_string();
        let parsed: serde_json::Value = serde_json::from_str(&json).expect("should parse");
        assert!(parsed["paths"]["/users"]["get"].is_object());
    }

    #[test]
    fn test_path_info_builder() {
        let p = PathInfo::new("PUT", "Update user")
            .with_response("200", "OK")
            .with_response("404", "Not found")
            .with_parameter(serde_json::json!({"name": "id", "in": "path"}));
        assert_eq!(p.method, "PUT");
        assert_eq!(p.responses.len(), 2);
        assert_eq!(p.parameters.len(), 1);
    }
}