silent-openapi 2.16.1

OpenAPI 3.0 support for Silent web framework
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
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
use std::collections::HashMap;
use std::sync::{Arc, Mutex};

use http::Method;
use once_cell::sync::Lazy;

use silent::prelude::{HandlerGetter, Route};
use silent::{
    Handler, HandlerWrapper, Request as SilentRequest, Response as SilentResponse,
    Result as SilentResult,
};
use utoipa::openapi::{Components, ComponentsBuilder, OpenApi};

/// 用于标注接口文档的元信息
#[derive(Clone, Debug)]
pub struct DocMeta {
    pub summary: Option<String>,
    pub description: Option<String>,
    pub deprecated: bool,
    pub tags: Vec<String>,
}

static DOC_REGISTRY: Lazy<Mutex<HashMap<usize, DocMeta>>> =
    Lazy::new(|| Mutex::new(HashMap::new()));

pub fn register_doc_by_ptr(ptr: usize, summary: Option<&str>, description: Option<&str>) {
    let mut map = DOC_REGISTRY.lock().expect("doc registry poisoned");
    map.insert(
        ptr,
        DocMeta {
            summary: summary.map(|s| s.to_string()),
            description: description.map(|s| s.to_string()),
            deprecated: false,
            tags: Vec::new(),
        },
    );
}

/// 注册文档元信息(带 deprecated 和 tags 支持)
pub fn register_doc_by_ptr_ext(
    ptr: usize,
    summary: Option<&str>,
    description: Option<&str>,
    deprecated: bool,
    tags: &[&str],
) {
    let mut map = DOC_REGISTRY.lock().expect("doc registry poisoned");
    map.insert(
        ptr,
        DocMeta {
            summary: summary.map(|s| s.to_string()),
            description: description.map(|s| s.to_string()),
            deprecated,
            tags: tags.iter().map(|s| s.to_string()).collect(),
        },
    );
}

pub(crate) fn lookup_doc_by_handler_ptr(ptr: usize) -> Option<DocMeta> {
    DOC_REGISTRY.lock().ok().and_then(|m| m.get(&ptr).cloned())
}

/// 响应类型元信息
#[derive(Clone, Debug)]
pub enum ResponseMeta {
    TextPlain,
    Json { type_name: &'static str },
}

static RESPONSE_REGISTRY: Lazy<Mutex<HashMap<usize, ResponseMeta>>> =
    Lazy::new(|| Mutex::new(HashMap::new()));

pub fn register_response_by_ptr(ptr: usize, meta: ResponseMeta) {
    let mut map = RESPONSE_REGISTRY
        .lock()
        .expect("response registry poisoned");
    map.insert(ptr, meta);
}

pub(crate) fn lookup_response_by_handler_ptr(ptr: usize) -> Option<ResponseMeta> {
    RESPONSE_REGISTRY
        .lock()
        .ok()
        .and_then(|m| m.get(&ptr).cloned())
}

pub fn list_registered_json_types() -> Vec<&'static str> {
    let map = RESPONSE_REGISTRY.lock().ok();
    let mut out = Vec::new();
    if let Some(map) = map {
        for meta in map.values() {
            if let ResponseMeta::Json { type_name } = meta
                && !out.contains(type_name)
            {
                out.push(*type_name);
            }
        }
    }
    out
}

// ====== 额外响应(非 200)注册 ======

/// 额外的 HTTP 响应描述(如 400、401、404 等)
#[derive(Clone, Debug)]
pub struct ExtraResponse {
    pub status: u16,
    pub description: String,
}

static EXTRA_RESPONSE_REGISTRY: Lazy<Mutex<HashMap<usize, Vec<ExtraResponse>>>> =
    Lazy::new(|| Mutex::new(HashMap::new()));

pub fn register_extra_response_by_ptr(ptr: usize, status: u16, description: &str) {
    let mut map = EXTRA_RESPONSE_REGISTRY
        .lock()
        .expect("extra response registry poisoned");
    map.entry(ptr).or_default().push(ExtraResponse {
        status,
        description: description.to_string(),
    });
}

pub(crate) fn lookup_extra_responses_by_handler_ptr(ptr: usize) -> Option<Vec<ExtraResponse>> {
    EXTRA_RESPONSE_REGISTRY
        .lock()
        .ok()
        .and_then(|m| m.get(&ptr).cloned())
}

// ====== 请求元信息注册 ======

/// 请求参数/请求体元信息
#[derive(Clone, Debug)]
pub enum RequestMeta {
    /// JSON 请求体(对应 Json<T> 提取器)
    JsonBody { type_name: &'static str },
    /// 表单请求体(对应 Form<T> 提取器)
    FormBody { type_name: &'static str },
    /// 查询参数(对应 Query<T> 提取器)
    QueryParams { type_name: &'static str },
}

static REQUEST_REGISTRY: Lazy<Mutex<HashMap<usize, Vec<RequestMeta>>>> =
    Lazy::new(|| Mutex::new(HashMap::new()));

pub fn register_request_by_ptr(ptr: usize, meta: RequestMeta) {
    let mut map = REQUEST_REGISTRY.lock().expect("request registry poisoned");
    map.entry(ptr).or_default().push(meta);
}

pub(crate) fn lookup_request_by_handler_ptr(ptr: usize) -> Option<Vec<RequestMeta>> {
    REQUEST_REGISTRY
        .lock()
        .ok()
        .and_then(|m| m.get(&ptr).cloned())
}

// ====== ToSchema 完整 schema 注册 ======
type SchemaRegFn = fn(&mut Components);
static SCHEMA_REGISTRY: Lazy<Mutex<Vec<SchemaRegFn>>> = Lazy::new(|| Mutex::new(Vec::new()));

pub fn register_schema_for<T>()
where
    T: crate::ToSchema + ::utoipa::PartialSchema + 'static,
{
    fn add_impl<U: crate::ToSchema + ::utoipa::PartialSchema>(components: &mut Components) {
        let mut refs: Vec<(
            String,
            ::utoipa::openapi::RefOr<::utoipa::openapi::schema::Schema>,
        )> = Vec::new();
        <U as crate::ToSchema>::schemas(&mut refs);
        for (name, schema) in refs {
            components.schemas.entry(name).or_insert(schema);
        }
        let name = <U as crate::ToSchema>::name().into_owned();
        let schema = <U as ::utoipa::PartialSchema>::schema();
        components.schemas.entry(name).or_insert(schema);
    }
    let mut reg = SCHEMA_REGISTRY.lock().expect("schema registry poisoned");
    reg.push(add_impl::<T> as SchemaRegFn);
}

pub fn apply_registered_schemas(openapi: &mut OpenApi) {
    let mut components = openapi
        .components
        .clone()
        .unwrap_or_else(|| ComponentsBuilder::new().build());
    if let Ok(reg) = SCHEMA_REGISTRY.lock() {
        for f in reg.iter() {
            f(&mut components);
        }
    }
    openapi.components = Some(components);
}

/// 路由文档标注扩展:在完成 handler 挂载后,追加文档说明
pub trait RouteDocMarkExt {
    fn doc(self, method: Method, summary: &str, description: &str) -> Self;
}

/// 便捷构造:将基于 Request 的处理函数包装为 `Arc<dyn Handler>` 并注册文档
pub fn handler_with_doc<F, Fut, T>(f: F, summary: &str, description: &str) -> Arc<dyn Handler>
where
    F: Fn(SilentRequest) -> Fut + Send + Sync + 'static,
    Fut: core::future::Future<Output = SilentResult<T>> + Send + 'static,
    T: Into<SilentResponse> + Send + 'static,
{
    let handler = Arc::new(HandlerWrapper::new(f));
    let ptr = Arc::as_ptr(&handler) as *const () as usize;
    register_doc_by_ptr(ptr, Some(summary), Some(description));
    handler
}

impl RouteDocMarkExt for Route {
    fn doc(self, method: Method, summary: &str, description: &str) -> Self {
        if let Some(handler) = self.handler.get(&method).cloned() {
            let ptr = Arc::as_ptr(&handler) as *const () as usize;
            register_doc_by_ptr(ptr, Some(summary), Some(description));
        }
        self
    }
}

/// 便捷追加:同时挂载处理器并标注文档
pub trait RouteDocAppendExt {
    fn get_with_doc(self, handler: Arc<dyn Handler>, summary: &str, description: &str) -> Self;
    fn post_with_doc(self, handler: Arc<dyn Handler>, summary: &str, description: &str) -> Self;
    fn put_with_doc(self, handler: Arc<dyn Handler>, summary: &str, description: &str) -> Self;
    fn delete_with_doc(self, handler: Arc<dyn Handler>, summary: &str, description: &str) -> Self;
    fn patch_with_doc(self, handler: Arc<dyn Handler>, summary: &str, description: &str) -> Self;
    fn options_with_doc(self, handler: Arc<dyn Handler>, summary: &str, description: &str) -> Self;
}

impl RouteDocAppendExt for Route {
    fn get_with_doc(self, handler: Arc<dyn Handler>, summary: &str, description: &str) -> Self {
        let ptr = Arc::as_ptr(&handler) as *const () as usize;
        register_doc_by_ptr(ptr, Some(summary), Some(description));
        <Route as HandlerGetter>::handler(self, Method::GET, handler)
    }

    fn post_with_doc(self, handler: Arc<dyn Handler>, summary: &str, description: &str) -> Self {
        let ptr = Arc::as_ptr(&handler) as *const () as usize;
        register_doc_by_ptr(ptr, Some(summary), Some(description));
        <Route as HandlerGetter>::handler(self, Method::POST, handler)
    }

    fn put_with_doc(self, handler: Arc<dyn Handler>, summary: &str, description: &str) -> Self {
        let ptr = Arc::as_ptr(&handler) as *const () as usize;
        register_doc_by_ptr(ptr, Some(summary), Some(description));
        <Route as HandlerGetter>::handler(self, Method::PUT, handler)
    }

    fn delete_with_doc(self, handler: Arc<dyn Handler>, summary: &str, description: &str) -> Self {
        let ptr = Arc::as_ptr(&handler) as *const () as usize;
        register_doc_by_ptr(ptr, Some(summary), Some(description));
        <Route as HandlerGetter>::handler(self, Method::DELETE, handler)
    }

    fn patch_with_doc(self, handler: Arc<dyn Handler>, summary: &str, description: &str) -> Self {
        let ptr = Arc::as_ptr(&handler) as *const () as usize;
        register_doc_by_ptr(ptr, Some(summary), Some(description));
        <Route as HandlerGetter>::handler(self, Method::PATCH, handler)
    }

    fn options_with_doc(self, handler: Arc<dyn Handler>, summary: &str, description: &str) -> Self {
        let ptr = Arc::as_ptr(&handler) as *const () as usize;
        register_doc_by_ptr(ptr, Some(summary), Some(description));
        <Route as HandlerGetter>::handler(self, Method::OPTIONS, handler)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde::Serialize;
    use utoipa::ToSchema;

    async fn ok_handler(_req: SilentRequest) -> SilentResult<SilentResponse> {
        Ok(SilentResponse::text("ok"))
    }

    #[test]
    fn test_register_and_lookup_doc() {
        let handler = Arc::new(HandlerWrapper::new(|_req: SilentRequest| async move {
            Ok::<_, silent::SilentError>(SilentResponse::text("doc"))
        }));
        let ptr = Arc::as_ptr(&handler) as *const () as usize;
        register_doc_by_ptr(ptr, Some("summary"), Some("desc"));
        let got = lookup_doc_by_handler_ptr(ptr).expect("doc meta");
        assert_eq!(got.summary.as_deref(), Some("summary"));
        assert_eq!(got.description.as_deref(), Some("desc"));
    }

    #[test]
    fn test_register_and_lookup_response() {
        let handler = Arc::new(HandlerWrapper::new(ok_handler));
        let ptr = Arc::as_ptr(&handler) as *const () as usize;
        register_response_by_ptr(ptr, ResponseMeta::TextPlain);
        let got = lookup_response_by_handler_ptr(ptr).expect("resp meta");
        matches!(got, ResponseMeta::TextPlain);
    }

    #[test]
    fn test_list_registered_json_types() {
        let h1 = Arc::new(HandlerWrapper::new(ok_handler));
        let h2 = Arc::new(HandlerWrapper::new(ok_handler));
        let p1 = Arc::as_ptr(&h1) as *const () as usize;
        let p2 = Arc::as_ptr(&h2) as *const () as usize;
        register_response_by_ptr(p1, ResponseMeta::Json { type_name: "User" });
        register_response_by_ptr(p2, ResponseMeta::Json { type_name: "User" });
        let list = list_registered_json_types();
        assert!(list.contains(&"User"));
        assert_eq!(list.len(), 1);
    }

    #[derive(Serialize, ToSchema)]
    struct FooSchema {
        id: i32,
        name: String,
    }

    #[test]
    fn test_register_schema_and_apply() {
        register_schema_for::<FooSchema>();
        let mut openapi = crate::OpenApiDoc::new("T", "1").into_openapi();
        apply_registered_schemas(&mut openapi);
        let components = openapi.components.expect("components");
        assert!(components.schemas.contains_key("FooSchema"));
    }

    // ====== 枚举变体文档测试 ======

    #[derive(Serialize, ToSchema)]
    #[allow(dead_code)]
    enum ApiResponse {
        Success { data: String },
        Error { code: i32, message: String },
    }

    #[test]
    fn test_register_enum_schema() {
        register_schema_for::<ApiResponse>();
        let mut openapi = crate::OpenApiDoc::new("T", "1").into_openapi();
        apply_registered_schemas(&mut openapi);
        let components = openapi.components.expect("components");
        assert!(components.schemas.contains_key("ApiResponse"));
    }

    #[derive(Serialize, ToSchema)]
    #[allow(dead_code)]
    enum Status {
        Active,
        Inactive,
        Pending,
    }

    #[test]
    fn test_register_unit_enum_schema() {
        register_schema_for::<Status>();
        let mut openapi = crate::OpenApiDoc::new("T", "1").into_openapi();
        apply_registered_schemas(&mut openapi);
        let components = openapi.components.expect("components");
        assert!(components.schemas.contains_key("Status"));
    }

    #[derive(Serialize, ToSchema)]
    struct NestedData {
        value: i32,
    }

    #[derive(Serialize, ToSchema)]
    #[allow(dead_code)]
    enum ComplexEnum {
        WithStruct(NestedData),
        WithString(String),
        Empty,
    }

    #[test]
    fn test_register_enum_with_nested_schemas() {
        register_schema_for::<ComplexEnum>();
        let mut openapi = crate::OpenApiDoc::new("T", "1").into_openapi();
        apply_registered_schemas(&mut openapi);
        let components = openapi.components.expect("components");
        assert!(components.schemas.contains_key("ComplexEnum"));
        // 嵌套的 NestedData 也应被注册
        assert!(components.schemas.contains_key("NestedData"));
    }

    #[test]
    fn test_register_request_and_lookup() {
        let handler = Arc::new(HandlerWrapper::new(ok_handler));
        let ptr = Arc::as_ptr(&handler) as *const () as usize;
        register_request_by_ptr(ptr, RequestMeta::JsonBody { type_name: "User" });
        register_request_by_ptr(
            ptr,
            RequestMeta::QueryParams {
                type_name: "Filter",
            },
        );
        let got = lookup_request_by_handler_ptr(ptr).expect("request meta");
        assert_eq!(got.len(), 2);
        assert!(matches!(
            &got[0],
            RequestMeta::JsonBody { type_name: "User" }
        ));
        assert!(matches!(
            &got[1],
            RequestMeta::QueryParams {
                type_name: "Filter"
            }
        ));
    }
}