rovo 0.4.5

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

#![allow(deprecated)]

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

#[derive(Clone)]
struct AppState {}

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

impl Default for User {
    fn default() -> Self {
        Self {
            id: 1,
            name: "Test User".into(),
        }
    }
}

/// Multi-line response description test
///
/// # Responses
///
/// 200: Json<User> - User found successfully. This is a
///     multi-line description that continues on the next line
///     and even continues further.
/// 404: () - User not found
#[rovo]
async fn multiline_response_description(State(_state): State<AppState>) -> impl IntoApiResponse {
    Json(User::default())
}

/// Code block example test
///
/// # Responses
///
/// 200: Json<User> - User found
///
/// # Examples
///
/// 200:
/// ```rust
/// User {
///     id: 1,
///     name: "Alice".into()
/// }
/// ```
#[rovo]
async fn codeblock_example(State(_state): State<AppState>) -> impl IntoApiResponse {
    Json(User::default())
}

/// Multi-line example with nested braces
///
/// # Responses
///
/// 200: Json<User> - Success
///
/// # Examples
///
/// 200: User {
///     id: 1,
///     name: "Bob".into()
/// }
#[rovo]
async fn multiline_example_braces(State(_state): State<AppState>) -> impl IntoApiResponse {
    Json(User::default())
}

/// Handler with deprecated attribute
///
/// # Responses
///
/// 200: Json<User> - Success
#[deprecated(note = "Use v2 API instead")]
#[rovo]
async fn deprecated_handler(State(_state): State<AppState>) -> impl IntoApiResponse {
    Json(User::default())
}

/// Handler with empty code block example
///
/// # Responses
///
/// 200: Json<User> - Success
///
/// # Examples
///
/// 200: ```
/// User::default()
/// ```
#[rovo]
async fn codeblock_inline_example(State(_state): State<AppState>) -> impl IntoApiResponse {
    Json(User::default())
}

#[test]
fn test_multiline_response_description_compiles() {
    let state = AppState {};
    let _router: ::axum::Router = Router::<AppState>::new()
        .route("/multiline", get(multiline_response_description))
        .with_state(state)
        .finish();
}

#[test]
fn test_codeblock_example_compiles() {
    let state = AppState {};
    let _router: ::axum::Router = Router::<AppState>::new()
        .route("/codeblock", get(codeblock_example))
        .with_state(state)
        .finish();
}

#[test]
fn test_multiline_example_braces_compiles() {
    let state = AppState {};
    let _router: ::axum::Router = Router::<AppState>::new()
        .route("/multiline-braces", get(multiline_example_braces))
        .with_state(state)
        .finish();
}

#[test]
fn test_deprecated_handler_compiles() {
    let state = AppState {};
    let _router: ::axum::Router = Router::<AppState>::new()
        .route("/deprecated", get(deprecated_handler))
        .with_state(state)
        .finish();
}

#[test]
fn test_codeblock_inline_example_compiles() {
    let state = AppState {};
    let _router: ::axum::Router = Router::<AppState>::new()
        .route("/codeblock-inline", get(codeblock_inline_example))
        .with_state(state)
        .finish();
}