utoipauto 0.2.0

Rust Macros to automate the addition of Paths/Schemas to Utoipa crate, simulating Reflection during the compilation phase
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

use utoipa::OpenApi;

use utoipauto::utoipauto;

use crate::default_features::controllers;

// Discover from multiple controllers
#[utoipauto(
    paths = "( crate::controllers::controller1 => ./utoipauto/tests/default_features/controllers/controller1.rs) ; ( crate::controllers::controller2 => ./utoipauto/tests/default_features/controllers/controller2.rs )"
)]
#[derive(OpenApi)]
#[openapi(info(title = "Percentage API", version = "1.0.0"))]
pub struct MultiControllerApiDocs {}

#[test]
fn test_path_import() {
    assert_eq!(MultiControllerApiDocs::openapi().paths.paths.len(), 2)
}

/// Discover from a single controller
#[utoipauto(
    paths = "( crate::controllers::controller1 => ./utoipauto/tests/default_features/controllers/controller1.rs)"
)]
#[derive(OpenApi)]
#[openapi(info(title = "Percentage API", version = "1.0.0"))]
pub struct SingleControllerApiDocs {}

#[test]
fn test_ignored_path() {
    assert_eq!(SingleControllerApiDocs::openapi().paths.paths.len(), 1)
}

/// Discover with manual path
#[utoipauto(paths = "./utoipauto/tests/default_features/controllers/controller1.rs")]
#[derive(OpenApi)]
#[openapi(
    info(title = "Percentage API", version = "1.0.0"),
    paths(controllers::controller2::route3)
)]
pub struct SingleControllerManualPathApiDocs {}

#[test]
fn test_manual_path() {
    assert_eq!(SingleControllerManualPathApiDocs::openapi().paths.paths.len(), 2)
}

/// Discover from a module root
#[utoipauto(paths = "( crate::controllers => ./utoipauto/tests/default_features/controllers)")]
#[derive(OpenApi)]
#[openapi(info(title = "Percentage API", version = "1.0.0"))]
pub struct ModuleApiDocs {}

#[test]
fn test_module_import_path() {
    assert_eq!(ModuleApiDocs::openapi().paths.paths.len(), 2)
}

/// Discover from the crate root
#[utoipauto(paths = "./utoipauto/tests/default_features")]
#[derive(OpenApi)]
#[openapi(info(title = "Percentage API", version = "1.0.0"))]
pub struct CrateApiDocs {}

#[test]
fn test_crate_import_path() {
    assert_eq!(CrateApiDocs::openapi().paths.paths.len(), 2)
}

// Discover from multiple controllers new syntax
#[utoipauto(
    paths = "./utoipauto/tests/default_features/controllers/controller1.rs, ./utoipauto/tests/default_features/controllers/controller2.rs"
)]
#[derive(OpenApi)]
#[openapi(info(title = "Percentage API", version = "1.0.0"))]
pub struct MultiControllerNoModuleApiDocs {}

#[test]
fn test_path_import_no_module() {
    assert_eq!(MultiControllerNoModuleApiDocs::openapi().paths.paths.len(), 2)
}

// Discover from multiple controllers new syntax
#[utoipauto(paths = "./utoipauto/tests/default_features/models.rs")]
#[derive(OpenApi)]
#[openapi(info(title = "Percentage API", version = "1.0.0"))]
pub struct ModelsImportApiDocs {}

#[test]
fn test_path_import_schema() {
    assert_eq!(
        ModelsImportApiDocs::openapi()
            .components
            .expect("no components")
            .schemas
            .len(),
        3, // 1 derive, 1 manual, 1 manual with utoipa::ToSchema
    )
}

// Discover from multiple controllers new syntax
#[utoipauto(paths = "./utoipauto/tests/default_features/models.rs")]
#[derive(OpenApi)]
#[openapi(info(title = "Percentage API", version = "1.0.0"))]
pub struct ResponsesImportApiDocs {}

#[test]
fn test_path_import_responses() {
    assert_eq!(
        ResponsesImportApiDocs::openapi()
            .components
            .expect("no components")
            .responses
            .len(),
        3, // 1 derive, 1 manual, 1 manual with utoipa::ToResponse
    )
}

/// Discover custom handler
#[utoipauto(
    paths = "./utoipauto/tests/default_features/controllers/controller3.rs",
    function_attribute_name = "test_handler"
)]
#[derive(OpenApi)]
#[openapi(info(title = "Percentage API", version = "1.0.0"))]
pub struct CustomHandlerApiDocs {}

#[test]
fn test_custom_handler() {
    assert_eq!(CustomHandlerApiDocs::openapi().paths.paths.len(), 1)
}