doxa-macros 0.1.2

Procedural macros for doxa: #[derive(ApiError)], #[derive(SseEvent)], and HTTP method shortcuts that delegate to utoipa::path.
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

//! Integration tests for the `#[get]` / `#[post]` / `#[operation]`
//! method shortcut attributes.
//!
//! These tests verify that the shortcut expands to a working
//! `#[utoipa::path]` attribute by registering a handler with
//! `utoipa_axum::router::OpenApiRouter` and inspecting the resulting
//! OpenAPI document.

use axum::Json;
use doxa::{routes, OpenApiRouter, ToSchema};
use doxa_macros::{delete, get, operation, patch, post, put};
use serde::Serialize;

#[derive(Serialize, ToSchema)]
struct Hello {
    message: String,
}

/// A trivial GET endpoint used to verify path + operation_id wiring.
#[get("/hello")]
async fn hello() -> Json<Hello> {
    Json(Hello {
        message: "hi".to_string(),
    })
}

/// POST endpoint to verify the shortcut works for body-bearing methods.
#[post("/hello")]
async fn hello_post() -> Json<Hello> {
    Json(Hello {
        message: "posted".to_string(),
    })
}

#[put("/hello")]
async fn hello_put() -> Json<Hello> {
    Json(Hello {
        message: "put".to_string(),
    })
}

#[patch("/hello")]
async fn hello_patch() -> Json<Hello> {
    Json(Hello {
        message: "patched".to_string(),
    })
}

#[delete("/hello")]
async fn hello_delete() -> Json<Hello> {
    Json(Hello {
        message: "deleted".to_string(),
    })
}

#[operation(get, "/operation-form")]
async fn operation_form() -> Json<Hello> {
    Json(Hello {
        message: "ok".to_string(),
    })
}

#[test]
fn shortcut_registers_path_in_openapi() {
    let (_, openapi) = OpenApiRouter::<()>::new()
        .routes(routes!(hello))
        .split_for_parts();
    let json = serde_json::to_value(&openapi).unwrap();
    assert!(json["paths"]["/hello"]["get"].is_object());
}

#[test]
fn operation_id_defaults_to_function_name() {
    let (_, openapi) = OpenApiRouter::<()>::new()
        .routes(routes!(hello))
        .split_for_parts();
    let json = serde_json::to_value(&openapi).unwrap();
    assert_eq!(json["paths"]["/hello"]["get"]["operationId"], "hello");
}

#[test]
fn all_method_shortcuts_compile_and_register() {
    let (_, openapi) = OpenApiRouter::<()>::new()
        .routes(routes!(
            hello,
            hello_post,
            hello_put,
            hello_patch,
            hello_delete
        ))
        .split_for_parts();
    let json = serde_json::to_value(&openapi).unwrap();
    let methods = &json["paths"]["/hello"];
    assert!(methods["get"].is_object());
    assert!(methods["post"].is_object());
    assert!(methods["put"].is_object());
    assert!(methods["patch"].is_object());
    assert!(methods["delete"].is_object());
}

#[test]
fn operation_attribute_works_with_explicit_method() {
    let (_, openapi) = OpenApiRouter::<()>::new()
        .routes(routes!(operation_form))
        .split_for_parts();
    let json = serde_json::to_value(&openapi).unwrap();
    assert!(json["paths"]["/operation-form"]["get"].is_object());
    assert_eq!(
        json["paths"]["/operation-form"]["get"]["operationId"],
        "operation_form"
    );
}