sz-rust-http-facade 0.6.7

HTTP facade for sz-rust framework — response, error, and request primitives
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

//! OpenAPI 3.0 文档自动生成
//!
//! 基于 utoipa 提供 OpenAPI spec 构建和 Swagger UI 集成。

use thiserror::Error;

/// OpenAPI 错误
#[derive(Debug, Error)]
pub enum OpenApiError {
    /// 构建错误
    #[error("OpenAPI build error: {0}")]
    Build(String),
    /// JSON 序列化错误
    #[error("JSON serialize error: {0}")]
    Serialize(String),
}

/// OpenAPI 构建器
///
/// 封装 utoipa::OpenApi 构建过程，提供链式 API。
pub struct OpenApiBuilder {
    title: String,
    version: String,
    description: Option<String>,
}

impl OpenApiBuilder {
    /// 创建 OpenAPI 构建器
    pub fn new(title: impl Into<String>, version: impl Into<String>) -> Self {
        Self {
            title: title.into(),
            version: version.into(),
            description: None,
        }
    }

    /// 设置描述
    pub fn description(mut self, desc: impl Into<String>) -> Self {
        self.description = Some(desc.into());
        self
    }

    /// 构建 OpenApi spec
    pub fn build(self) -> utoipa::openapi::Info {
        let mut info = utoipa::openapi::Info::default();
        info.title = self.title;
        info.version = self.version;
        info.description = self.description;
        info
    }

    /// 构建并序列化为 JSON
    pub fn to_json(self) -> Result<String, OpenApiError> {
        let info = self.build();
        serde_json::to_string_pretty(&info).map_err(|e| OpenApiError::Serialize(e.to_string()))
    }

    /// 验证 OpenAPI spec
    pub fn validate(self) -> Result<(), OpenApiError> {
        let info = self.build();
        if info.title.is_empty() {
            return Err(OpenApiError::Build("title is empty".into()));
        }
        if info.version.is_empty() {
            return Err(OpenApiError::Build("version is empty".into()));
        }
        Ok(())
    }
}

/// 挂载 Swagger UI 路由
///
/// 需启用 `swagger-ui` feature。
#[cfg(feature = "swagger-ui")]
pub fn swagger_ui_routes() -> axum::Router {
    utoipa_swagger_ui::SwaggerUi::new("/docs/{_:.*}")
        .url("/api-docs/openapi.json", utoipa::OpenApi::default())
        .into()
}

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

    #[test]
    fn test_openapi_build() {
        let info = OpenApiBuilder::new("Test API", "1.0.0").build();
        assert_eq!(info.title, "Test API");
        assert_eq!(info.version, "1.0.0");
    }

    #[test]
    fn test_openapi_to_json() {
        let json = OpenApiBuilder::new("Test API", "1.0.0").to_json().unwrap();
        assert!(json.contains("Test API"));
        assert!(json.contains("1.0.0"));
    }

    #[test]
    fn test_openapi_validate() {
        let result = OpenApiBuilder::new("Test", "1.0").validate();
        assert!(result.is_ok());
    }

    #[test]
    fn test_openapi_validate_empty_title() {
        let result = OpenApiBuilder::new("", "1.0").validate();
        assert!(result.is_err());
    }

    #[test]
    fn test_openapi_error_display() {
        let err = OpenApiError::Build("test error".into());
        assert_eq!(err.to_string(), "OpenAPI build error: test error");
    }
}