rovo 0.4.4

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

use rovo::aide::axum::IntoApiResponse;
use rovo::extract::{Path, State};
use rovo::response::Json;
use rovo::schemars::JsonSchema;
use rovo::{routing::get, rovo, Router};
use serde::{Deserialize, Serialize};
use uuid::Uuid;

#[derive(Clone)]
struct AppState {}

#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq)]
struct User {
    id: Uuid,
    name: String,
    email: String,
}

impl Default for User {
    fn default() -> Self {
        Self {
            id: Uuid::nil(),
            name: "John Doe".into(),
            email: "john@example.com".into(),
        }
    }
}

#[derive(Deserialize, JsonSchema)]
struct UserId {
    #[allow(dead_code)]
    id: Uuid,
}

/// Get user by ID
///
/// Retrieves a user's information using their unique identifier.
///
/// # Responses
///
/// 200: Json<User> - User found and returned successfully
/// 404: () - User not found in the system
///
/// # Examples
///
/// 200: User::default()
#[rovo]
async fn get_user(State(_state): State<AppState>, Path(_id): Path<UserId>) -> impl IntoApiResponse {
    Json(User::default())
}

#[test]
fn test_with_example() {
    let _state = AppState {};

    let _router: ::axum::Router = Router::<AppState>::new()
        .route("/users/{id}", get(get_user))
        .with_state(_state)
        .finish();
}