tideway 0.7.17

A batteries-included Rust web framework built on Axum for building SaaS applications quickly
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

/// OpenAPI configuration for controlling documentation generation and serving
#[derive(Debug, Clone)]
pub struct OpenApiConfig {
    /// Enable OpenAPI feature
    pub enabled: bool,

    /// Serve Swagger UI (typically disable in production)
    pub swagger_ui: bool,

    /// Serve OpenAPI JSON spec endpoint
    pub serve_spec: bool,

    /// Path to serve Swagger UI
    pub swagger_ui_path: String,

    /// Path to serve OpenAPI spec
    pub spec_path: String,

    /// Visibility filter for endpoints
    pub visibility: OpenApiVisibility,
}

/// Controls which endpoints are included in the OpenAPI spec
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum OpenApiVisibility {
    /// Include all documented endpoints
    All,
    /// Only include endpoints tagged as "public" (exclude internal)
    PublicOnly,
    /// Only include internal endpoints
    InternalOnly,
}

impl Default for OpenApiConfig {
    fn default() -> Self {
        Self {
            enabled: false,
            swagger_ui: false,
            serve_spec: false,
            swagger_ui_path: "/swagger-ui".to_string(),
            spec_path: "/api-docs/openapi.json".to_string(),
            visibility: OpenApiVisibility::All,
        }
    }
}

impl OpenApiConfig {
    /// Create config from environment variables
    pub fn from_env() -> Self {
        let enabled = std::env::var("OPENAPI_ENABLED")
            .ok()
            .and_then(|v| v.parse().ok())
            .unwrap_or(false);

        let swagger_ui = std::env::var("OPENAPI_SWAGGER_UI")
            .ok()
            .and_then(|v| v.parse().ok())
            .unwrap_or(false);

        let serve_spec = std::env::var("OPENAPI_SERVE_SPEC")
            .ok()
            .and_then(|v| v.parse().ok())
            .unwrap_or(false);

        let visibility = std::env::var("OPENAPI_VISIBILITY")
            .ok()
            .and_then(|v| match v.to_lowercase().as_str() {
                "public" | "public-only" => Some(OpenApiVisibility::PublicOnly),
                "internal" | "internal-only" => Some(OpenApiVisibility::InternalOnly),
                "all" => Some(OpenApiVisibility::All),
                _ => None,
            })
            .unwrap_or(OpenApiVisibility::All);

        Self {
            enabled,
            swagger_ui,
            serve_spec,
            visibility,
            ..Default::default()
        }
    }

    /// Builder: Enable OpenAPI
    pub fn enable(mut self) -> Self {
        self.enabled = true;
        self
    }

    /// Builder: Enable Swagger UI
    pub fn with_swagger_ui(mut self) -> Self {
        self.swagger_ui = true;
        self
    }

    /// Builder: Enable spec endpoint
    pub fn with_spec(mut self) -> Self {
        self.serve_spec = true;
        self
    }

    /// Builder: Set visibility filter
    pub fn visibility(mut self, visibility: OpenApiVisibility) -> Self {
        self.visibility = visibility;
        self
    }
}