rocket_okapi 0.9.0

OpenAPI (AKA Swagger) document generation for Rocket applications
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

//! This test ensures that routes can be marked as deprecated by using `#[openapi(deprecated)]`.

use rocket_okapi::openapi_get_spec;

// These functions are never actually called.
#[allow(unused)]
mod endpoints {
    use rocket::{get, serde::json::Json};
    use rocket_okapi::openapi;

    #[openapi(deprecated = true)]
    #[get("/explicit")]
    pub fn explicit_controller() -> Json<()> {
        Json(())
    }

    #[openapi(deprecated)]
    #[get("/implicit")]
    pub fn implicit_controller() -> Json<()> {
        Json(())
    }

    #[openapi]
    #[get("/default")]
    pub fn default_controller() -> Json<()> {
        Json(())
    }
}

#[test]
fn deprecated_with_explicit_value_is_deprecated() {
    let spec = openapi_get_spec![endpoints::explicit_controller];

    let operation = spec.paths["/explicit"].get.as_ref().unwrap();
    assert!(operation.deprecated);
}

#[test]
fn deprecated_with_implicit_value_is_deprecated() {
    let spec = openapi_get_spec![endpoints::implicit_controller];

    let operation = spec.paths["/implicit"].get.as_ref().unwrap();
    assert!(operation.deprecated);
}

#[test]
fn default_is_not_deprecated() {
    let spec = openapi_get_spec![endpoints::default_controller];

    let operation = spec.paths["/default"].get.as_ref().unwrap();
    assert!(!operation.deprecated);
}