okapi-operation 0.3.0

Procedural macro for generating OpenAPI operation specification (using okapi)
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

#[cfg(feature = "axum")]
#[allow(deprecated)]
mod openapi {
    use axum::Json;
    use okapi::{openapi3::RefOr, schemars::gen::SchemaGenerator};
    use okapi_operation::{
        axum_integration::{Router, get},
        oh, openapi,
    };

    #[test]
    fn json_body_detection() {
        #[openapi]
        async fn handle(_arg: Json<String>) {}

        let schema = Router::<()>::new()
            .route("/", get(oh!(handle)))
            .generate_openapi_builder()
            .build()
            .expect("Schema generation shoildn't fail");

        let operation = schema.paths["/"]
            .clone()
            .get
            .expect("GET / should be present")
            .request_body
            .expect("GET / request body should be present");
        let RefOr::Object(request_body) = operation else {
            panic!("GET / request body should be RefOr::Object");
        };

        let body_schema = request_body.content["application/json"]
            .clone()
            .schema
            .expect("GET / request body schema should be present");

        let mut gen = SchemaGenerator::default();
        let expected_schema = gen.subschema_for::<String>().into_object();

        assert_eq!(body_schema, expected_schema);
    }

    #[test]
    fn string_body_detection() {
        #[openapi]
        async fn handle(_arg: String) {}

        let schema = Router::<()>::new()
            .route("/", get(oh!(handle)))
            .generate_openapi_builder()
            .build()
            .expect("Schema generation shoildn't fail");

        let operation = schema.paths["/"]
            .clone()
            .get
            .expect("GET / should be present")
            .request_body
            .expect("GET / request body should be present");
        let RefOr::Object(request_body) = operation else {
            panic!("GET / request body should be RefOr::Object");
        };

        assert!(
            request_body.content["text/plain"].clone().schema.is_none(),
            "String body (text/plain) shouldn't have schema"
        );
    }
}

#[cfg(feature = "axum")]
#[allow(deprecated)]
mod openapi_handler {
    use axum::body::Body;
    use http::Request;
    use okapi_operation::{
        axum_integration::{Router, get},
        oh, openapi, openapi_handler, openapi_service,
    };

    #[test]
    fn openapi_handler_name() {
        #[openapi]
        async fn handle() {}

        let _ = Router::<()>::new().route("/", get(oh!(handle)));
    }

    #[test]
    fn openapi_handler_path() {
        mod outer {
            pub mod inner {
                use okapi_operation::*;

                #[openapi]
                pub async fn handle() {}
            }
        }

        let _ = Router::<()>::new().route("/", get(openapi_handler!(outer::inner::handle)));
    }

    #[test]
    fn openapi_handler_method() {
        struct S {}

        impl S {
            #[openapi]
            async fn handle() {}
        }

        let _ = Router::<()>::new().route("/", get(openapi_handler!(S::handle)));
    }

    #[test]
    fn openapi_handler_typed() {
        #[openapi]
        #[allow(clippy::extra_unused_type_parameters)]
        async fn handle<T>() {}

        let _ = Router::<()>::new().route("/", get(openapi_handler!(handle::<()>)));
    }

    #[test]
    #[allow(deprecated)]
    fn openapi_service_name() {
        #[openapi]
        async fn service(_: Request<Body>) {
            unimplemented!()
        }

        let _ = Router::<()>::new().route("/", get(openapi_service!(service)));
    }
}