uxum 0.9.4

Opinionated backend service framework based on axum
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

//! OpenAPI schema generation for handler responses.

use axum::http::StatusCode;
use okapi::openapi3;
use schemars::gen::SchemaGenerator;

/// Object for documenting handler responses as OpenAPI schema.
pub struct ResponseSchema {
    /// HTTP status code.
    pub status: StatusCode,
    /// OpenAPI response spec.
    pub response: openapi3::Response,
}

/// Trait used to generate OpenAPI schemas from handler response types.
pub trait GetResponseSchemas {
    /// Iterator over all available responses.
    type ResponseIter: IntoIterator<Item = ResponseSchema>;

    /// Get all available responses.
    #[must_use]
    fn get_response_schemas(gen: &mut schemars::gen::SchemaGenerator) -> Self::ResponseIter;

    /// Convert responses into [`openapi3::Responses`] object.
    #[must_use]
    fn get_responses(gen: &mut schemars::gen::SchemaGenerator) -> openapi3::Responses {
        openapi3::Responses {
            responses: Self::get_response_schemas(gen)
                .into_iter()
                .map(|sch| {
                    (
                        sch.status.as_u16().to_string(),
                        openapi3::RefOr::Object(sch.response),
                    )
                })
                .collect(),
            ..Default::default()
        }
    }
}

mod impls {
    use axum::Json;
    use okapi::schemars;
    use schemars::JsonSchema;

    use super::*;

    impl GetResponseSchemas for String {
        type ResponseIter = [ResponseSchema; 1];

        fn get_response_schemas(gen: &mut SchemaGenerator) -> Self::ResponseIter {
            [ResponseSchema {
                status: StatusCode::OK,
                response: openapi3::Response {
                    description: "UTF-8 string response".into(), // TODO: allow customization.
                    content: okapi::map! {
                        "text/plain; charset=utf-8".into() => openapi3::MediaType {
                            schema: Some(gen.subschema_for::<String>().into_object()),
                            ..Default::default()
                        },
                    },
                    ..Default::default()
                },
            }]
        }
    }

    impl GetResponseSchemas for str {
        type ResponseIter = [ResponseSchema; 1];

        fn get_response_schemas(gen: &mut SchemaGenerator) -> Self::ResponseIter {
            <String as GetResponseSchemas>::get_response_schemas(gen)
        }
    }

    impl GetResponseSchemas for () {
        type ResponseIter = [ResponseSchema; 1];

        fn get_response_schemas(_gen: &mut SchemaGenerator) -> Self::ResponseIter {
            [ResponseSchema {
                status: StatusCode::OK,
                response: openapi3::Response {
                    description: "Empty response body".into(),
                    ..Default::default()
                },
            }]
        }
    }

    impl<T> GetResponseSchemas for &'_ T
    where
        T: GetResponseSchemas + ?Sized,
    {
        type ResponseIter = T::ResponseIter;
        fn get_response_schemas(gen: &mut SchemaGenerator) -> Self::ResponseIter {
            T::get_response_schemas(gen)
        }
    }

    impl<T> GetResponseSchemas for Box<T>
    where
        T: GetResponseSchemas,
    {
        type ResponseIter = T::ResponseIter;

        fn get_response_schemas(gen: &mut schemars::gen::SchemaGenerator) -> Self::ResponseIter {
            T::get_response_schemas(gen)
        }
    }

    impl<T> GetResponseSchemas for Json<T>
    where
        T: JsonSchema,
    {
        type ResponseIter = [ResponseSchema; 1];

        fn get_response_schemas(gen: &mut SchemaGenerator) -> Self::ResponseIter {
            [ResponseSchema {
                status: StatusCode::OK,
                response: openapi3::Response {
                    description: "Serialized JSON".into(), // FIXME: get from schema.
                    content: okapi::map! {
                        "application/json".into() => openapi3::MediaType {
                            schema: Some(gen.subschema_for::<T>().into_object()),
                            ..Default::default()
                        },
                    },
                    ..Default::default()
                },
            }]
        }
    }

    impl<T, E> GetResponseSchemas for Result<T, E>
    where
        T: GetResponseSchemas,
        E: GetResponseSchemas,
    {
        type ResponseIter = Vec<ResponseSchema>;

        fn get_response_schemas(gen: &mut SchemaGenerator) -> Self::ResponseIter {
            T::get_response_schemas(gen)
                .into_iter()
                // FIXME: This will overwrite T's responses if E has responses with same status
                // codes.
                .chain(E::get_response_schemas(gen))
                .collect()
        }
    }
}