rovo 0.4.8

A drop-in replacement for axum::Router with effortless OpenAPI documentation
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
#![allow(clippy::needless_update)]

use rovo::aide::openapi::OpenApi;
use rovo::extract::{Path, State};
use rovo::http::StatusCode;
use rovo::response::{IntoResponse, Json, Response};
use rovo::routing::get;
use rovo::schemars::JsonSchema;
use rovo::{rovo, Router};
use serde::{Deserialize, Serialize};

#[derive(Clone)]
struct AppState;

#[derive(Serialize, JsonSchema, Default)]
struct User {
    id: u64,
    name: String,
}

#[derive(Deserialize, JsonSchema)]
struct UserId {
    id: u64,
}

/// Get user by ID.
///
/// Returns user information for the specified ID.
///
/// # Responses
///
/// 200: Json<User> - User found successfully
/// 404: () - User not found
///
/// # Examples
///
/// 200: User::default()
///
/// # Metadata
///
/// @tag users
/// @tag accounts
#[rovo]
async fn get_user(State(_state): State<AppState>, Path(UserId { id }): Path<UserId>) -> Response {
    if id == 1 {
        Json(User {
            id: 1,
            name: "Alice".to_string(),
        })
        .into_response()
    } else {
        StatusCode::NOT_FOUND.into_response()
    }
}

/// List all users.
///
/// Returns a list of all users in the system.
///
/// # Responses
///
/// 200: Json<Vec<User>> - List of all users
///
/// # Metadata
///
/// @tag users
#[rovo]
async fn list_users(State(_state): State<AppState>) -> Json<Vec<User>> {
    Json(vec![User {
        id: 1,
        name: "Alice".to_string(),
    }])
}

#[test]
fn test_spec_contains_paths() {
    let state = AppState;
    let mut api = OpenApi::default();
    api.info.title = "Test API".to_string();

    let app = Router::new()
        .route("/users", get(list_users))
        .route("/users/{id}", get(get_user))
        .with_oas(api.clone())
        .with_state(state)
        .finish();

    // Extract the OpenAPI spec from the Extension layer
    let spec = extract_openapi_from_router(app);

    // Verify paths exist
    assert!(spec.paths.is_some(), "OpenAPI spec should have paths");
    let paths = &spec.paths.as_ref().unwrap().paths;

    assert!(paths.contains_key("/users"), "Should contain /users path");
    assert!(
        paths.contains_key("/users/{id}"),
        "Should contain /users/{{id}} path"
    );
}

#[test]
fn test_spec_contains_tags() {
    let state = AppState;
    let mut api = OpenApi::default();
    api.info.title = "Test API".to_string();

    let app = Router::new()
        .route("/users/{id}", get(get_user))
        .with_oas(api.clone())
        .with_state(state)
        .finish();

    let spec = extract_openapi_from_router(app);

    // Verify the operation has tags
    let paths = &spec.paths.as_ref().unwrap().paths;
    let user_path = get_path_item(paths.get("/users/{id}").unwrap());
    let get_op = user_path.get.as_ref().unwrap();

    assert!(
        get_op.tags.contains(&"users".to_string()),
        "Should contain 'users' tag"
    );
    assert!(
        get_op.tags.contains(&"accounts".to_string()),
        "Should contain 'accounts' tag"
    );
}

#[test]
fn test_spec_contains_descriptions() {
    let state = AppState;
    let mut api = OpenApi::default();
    api.info.title = "Test API".to_string();

    let app = Router::new()
        .route("/users/{id}", get(get_user))
        .with_oas(api.clone())
        .with_state(state)
        .finish();

    let spec = extract_openapi_from_router(app);

    // Verify operation has summary and description
    let paths = &spec.paths.as_ref().unwrap().paths;
    let user_path = get_path_item(paths.get("/users/{id}").unwrap());
    let get_op = user_path.get.as_ref().unwrap();

    assert!(get_op.summary.is_some(), "Should have summary");
    assert_eq!(get_op.summary.as_ref().unwrap(), "Get user by ID.");

    assert!(get_op.description.is_some(), "Should have description");
    assert!(get_op
        .description
        .as_ref()
        .unwrap()
        .contains("Returns user information"));
}

#[test]
fn test_spec_contains_parameters() {
    let state = AppState;
    let mut api = OpenApi::default();
    api.info.title = "Test API".to_string();

    let app = Router::new()
        .route("/users/{id}", get(get_user))
        .with_oas(api.clone())
        .with_state(state)
        .finish();

    let spec = extract_openapi_from_router(app);

    // Verify operation has path parameters
    let paths = &spec.paths.as_ref().unwrap().paths;
    let user_path = get_path_item(paths.get("/users/{id}").unwrap());
    let get_op = user_path.get.as_ref().unwrap();

    assert!(!get_op.parameters.is_empty(), "Should have parameters");

    // Find the 'id' parameter
    let id_param = get_op.parameters.iter().find(|p| {
        matches!(p,
            rovo::aide::openapi::ReferenceOr::Item(
                rovo::aide::openapi::Parameter::Path { parameter_data, .. }
            ) if parameter_data.name == "id"
        )
    });

    assert!(id_param.is_some(), "Should have 'id' path parameter");
}

#[test]
fn test_spec_contains_responses() {
    let state = AppState;
    let mut api = OpenApi::default();
    api.info.title = "Test API".to_string();

    let app = Router::new()
        .route("/users/{id}", get(get_user))
        .with_oas(api.clone())
        .with_state(state)
        .finish();

    let spec = extract_openapi_from_router(app);

    // Verify operation has responses
    let paths = &spec.paths.as_ref().unwrap().paths;
    let user_path = get_path_item(paths.get("/users/{id}").unwrap());
    let get_op = user_path.get.as_ref().unwrap();

    assert!(get_op.responses.is_some(), "Should have responses");
    let responses = get_op.responses.as_ref().unwrap();

    let status_200 = aide::openapi::StatusCode::Code(200);
    let status_404 = aide::openapi::StatusCode::Code(404);

    assert!(
        responses.responses.contains_key(&status_200),
        "Should have 200 response"
    );
    assert!(
        responses.responses.contains_key(&status_404),
        "Should have 404 response"
    );

    // Verify 200 response has description
    if let aide::openapi::ReferenceOr::Item(response_200) =
        responses.responses.get(&status_200).unwrap()
    {
        assert_eq!(response_200.description, "User found successfully");
    } else {
        panic!("200 response should be an Item, not a Reference");
    }
}

#[test]
fn test_spec_contains_examples() {
    let state = AppState;
    let mut api = OpenApi::default();
    api.info.title = "Test API".to_string();

    let app = Router::new()
        .route("/users/{id}", get(get_user))
        .with_oas(api.clone())
        .with_state(state)
        .finish();

    let spec = extract_openapi_from_router(app);

    // Verify operation has response examples
    let paths = &spec.paths.as_ref().unwrap().paths;
    let user_path = get_path_item(paths.get("/users/{id}").unwrap());
    let get_op = user_path.get.as_ref().unwrap();
    let responses = get_op.responses.as_ref().unwrap();

    let status_200 = aide::openapi::StatusCode::Code(200);
    if let aide::openapi::ReferenceOr::Item(response_200) =
        responses.responses.get(&status_200).unwrap()
    {
        assert!(
            response_200.content.contains_key("application/json"),
            "Should have JSON content"
        );

        let json_content = response_200.content.get("application/json").unwrap();
        assert!(json_content.example.is_some(), "Should have example");
    }
}

#[test]
fn test_spec_contains_operation_id() {
    let state = AppState;
    let mut api = OpenApi::default();
    api.info.title = "Test API".to_string();

    let app = Router::new()
        .route("/users/{id}", get(get_user))
        .with_oas(api.clone())
        .with_state(state)
        .finish();

    let spec = extract_openapi_from_router(app);

    // Verify operation has operation_id (defaults to function name)
    let paths = &spec.paths.as_ref().unwrap().paths;
    let user_path = get_path_item(paths.get("/users/{id}").unwrap());
    let get_op = user_path.get.as_ref().unwrap();

    assert!(get_op.operation_id.is_some(), "Should have operation_id");
    assert_eq!(get_op.operation_id.as_ref().unwrap(), "get_user");
}

#[test]
fn test_spec_contains_multiline_example_with_default() {
    /// Create a new item.
    ///
    /// # Responses
    ///
    /// 201: Json<User> - Item created successfully
    ///
    /// # Examples
    ///
    /// 201: User {
    ///     id: 1,
    ///     name: "Test User".to_string(),
    ///     ..Default::default()
    /// }
    ///
    /// # Metadata
    ///
    /// @tag users
    #[rovo]
    async fn create_item(State(_state): State<AppState>) -> (StatusCode, Json<User>) {
        (
            StatusCode::CREATED,
            Json(User {
                id: 1,
                name: "Test".to_string(),
            }),
        )
    }

    let state = AppState;
    let mut api = OpenApi::default();
    api.info.title = "Test API".to_string();

    let app = Router::new()
        .route("/items", rovo::routing::post(create_item))
        .with_oas(api.clone())
        .with_state(state)
        .finish();

    let spec = extract_openapi_from_router(app);

    // Verify operation has response examples
    let paths = &spec.paths.as_ref().unwrap().paths;
    let items_path = get_path_item(paths.get("/items").unwrap());
    let post_op = items_path.post.as_ref().unwrap();
    let responses = post_op.responses.as_ref().unwrap();

    let status_201 = aide::openapi::StatusCode::Code(201);
    assert!(
        responses.responses.contains_key(&status_201),
        "Should have 201 response"
    );

    if let aide::openapi::ReferenceOr::Item(response_201) =
        responses.responses.get(&status_201).unwrap()
    {
        assert!(
            response_201.content.contains_key("application/json"),
            "Should have JSON content"
        );

        let json_content = response_201.content.get("application/json").unwrap();
        assert!(json_content.example.is_some(), "Should have example");

        // Verify the example contains the multi-line content
        let example_json = serde_json::to_string(&json_content.example.as_ref().unwrap()).unwrap();
        assert!(
            example_json.contains("id"),
            "Example should contain 'id' field"
        );
        assert!(
            example_json.contains("name"),
            "Example should contain 'name' field"
        );
    }
}

#[test]
fn test_spec_contains_request_body() {
    use rovo::aide::axum::IntoApiResponse;
    use rovo::response::Json;

    #[derive(Deserialize, JsonSchema)]
    struct CreateUserRequest {
        name: String,
    }

    /// Create a new user.
    ///
    /// # Responses
    ///
    /// 201: Json<User> - User created successfully
    ///
    /// # Metadata
    ///
    /// @tag users
    #[rovo]
    async fn create_user(
        State(_state): State<AppState>,
        Json(req): Json<CreateUserRequest>,
    ) -> impl IntoApiResponse {
        (
            StatusCode::CREATED,
            Json(User {
                id: 1,
                name: req.name,
            }),
        )
    }

    let state = AppState;
    let mut api = OpenApi::default();
    api.info.title = "Test API".to_string();

    let app = Router::new()
        .route("/users", rovo::routing::post(create_user))
        .with_oas(api.clone())
        .with_state(state)
        .finish();

    let spec = extract_openapi_from_router(app);

    // Verify operation has request body
    let paths = &spec.paths.as_ref().unwrap().paths;
    let users_path = get_path_item(paths.get("/users").unwrap());
    let post_op = users_path.post.as_ref().unwrap();

    assert!(post_op.request_body.is_some(), "Should have request body");
}

// Helper function to extract PathItem from ReferenceOr
fn get_path_item(
    path: &aide::openapi::ReferenceOr<aide::openapi::PathItem>,
) -> &aide::openapi::PathItem {
    match path {
        aide::openapi::ReferenceOr::Item(item) => item,
        _ => panic!("Expected PathItem, got Reference"),
    }
}

// Helper function to extract OpenAPI spec from the router
fn extract_openapi_from_router(app: ::axum::Router) -> OpenApi {
    use axum::body::Body;
    use axum::http::Request;
    use tower::util::ServiceExt;

    // Create a runtime to execute async code
    let rt = tokio::runtime::Runtime::new().unwrap();

    rt.block_on(async {
        // Make a request to the /api.json endpoint
        let response = app
            .oneshot(
                Request::builder()
                    .uri("/api.json")
                    .body(Body::empty())
                    .unwrap(),
            )
            .await
            .unwrap();

        // Extract the body
        let body = axum::body::to_bytes(response.into_body(), usize::MAX)
            .await
            .unwrap();

        // Parse the JSON into OpenApi
        serde_json::from_slice(&body).unwrap()
    })
}