salvo-oapi 0.96.0

OpenApi support for Salvo 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

//! Request parameter extractors for the API operation.

pub use salvo_core::extract::{CookieParam, HeaderParam, PathParam, QueryParam};

use crate::endpoint::EndpointArgRegister;
use crate::{Components, Operation, Parameter, ParameterIn, ToSchema};

impl<T, const REQUIRED: bool> EndpointArgRegister for CookieParam<T, REQUIRED>
where
    T: ToSchema,
{
    fn register(components: &mut Components, operation: &mut Operation, arg: &str) {
        let parameter = Parameter::new(arg)
            .location(ParameterIn::Cookie)
            .description(format!("Get parameter `{arg}` from request cookie."))
            .schema(T::to_schema(components))
            .required(REQUIRED);
        operation.parameters.insert(parameter);
    }
}

impl<T, const REQUIRED: bool> EndpointArgRegister for HeaderParam<T, REQUIRED>
where
    T: ToSchema,
{
    fn register(components: &mut Components, operation: &mut Operation, arg: &str) {
        let parameter = Parameter::new(arg)
            .location(ParameterIn::Header)
            .description(format!("Get parameter `{arg}` from request headers."))
            .schema(T::to_schema(components))
            .required(REQUIRED);
        operation.parameters.insert(parameter);
    }
}

impl<T> EndpointArgRegister for PathParam<T>
where
    T: ToSchema,
{
    fn register(components: &mut Components, operation: &mut Operation, arg: &str) {
        let parameter = Parameter::new(arg)
            .location(ParameterIn::Path)
            .description(format!("Get parameter `{arg}` from request url path."))
            .schema(T::to_schema(components))
            .required(true);
        operation.parameters.insert(parameter);
    }
}

impl<T, const REQUIRED: bool> EndpointArgRegister for QueryParam<T, REQUIRED>
where
    T: ToSchema,
{
    fn register(components: &mut Components, operation: &mut Operation, arg: &str) {
        let parameter = Parameter::new(arg)
            .location(ParameterIn::Query)
            .description(format!("Get parameter `{arg}` from request url query."))
            .schema(T::to_schema(components))
            .required(REQUIRED);
        operation.parameters.insert(parameter);
    }
}

#[cfg(test)]
mod tests {
    use assert_json_diff::assert_json_eq;
    use serde_json::json;

    use super::*;

    #[test]
    fn test_cookie_param_register() {
        let mut components = Components::new();
        let mut operation = Operation::new();
        CookieParam::<String, false>::register(&mut components, &mut operation, "arg");

        assert_json_eq!(
            operation,
            json!({
                "parameters": [{
                    "name": "arg",
                    "in": "cookie",
                    "description": "Get parameter `arg` from request cookie.",
                    "required": false,
                    "schema": { "type": "string" }
                }],
                "responses": {}
            })
        );
    }

    #[test]
    fn test_header_param_register() {
        let mut components = Components::new();
        let mut operation = Operation::new();
        HeaderParam::<String, false>::register(&mut components, &mut operation, "arg");

        assert_json_eq!(
            operation,
            json!({
                "parameters": [{
                    "name": "arg",
                    "in": "header",
                    "description": "Get parameter `arg` from request headers.",
                    "required": false,
                    "schema": { "type": "string" }
                }],
                "responses": {}
            })
        );
    }

    #[test]
    fn test_path_param_register() {
        let mut components = Components::new();
        let mut operation = Operation::new();
        PathParam::<String>::register(&mut components, &mut operation, "arg");

        assert_json_eq!(
            operation,
            json!({
                "parameters": [{
                    "name": "arg",
                    "in": "path",
                    "description": "Get parameter `arg` from request url path.",
                    "required": true,
                    "schema": { "type": "string" }
                }],
                "responses": {}
            })
        );
    }

    #[test]
    fn test_query_param_register() {
        let mut components = Components::new();
        let mut operation = Operation::new();
        QueryParam::<String, false>::register(&mut components, &mut operation, "arg");

        assert_json_eq!(
            operation,
            json!({
                "parameters": [{
                    "name": "arg",
                    "in": "query",
                    "description": "Get parameter `arg` from request url query.",
                    "required": false,
                    "schema": { "type": "string" }
                }],
                "responses": {}
            })
        );
    }
}