caelix 0.0.28

Public Caelix framework crate.
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

#![cfg(feature = "openapi")]

use caelix::openapi::{
    OpenApiConfig, Security, ToSchema, errors, request_header, response, security, utoipa,
};
use caelix::{
    BadRequestException, ConflictException, Module, ModuleMetadata, Response, Result,
    TestApplication, controller, injectable,
};
use serde::{Deserialize, Serialize};
use serde_json::Value;

#[derive(Clone, Deserialize, Serialize, ToSchema)]
struct PaymentDto {
    id: String,
}

#[injectable]
struct DocumentationController;

#[controller("/payments")]
impl DocumentationController {
    #[post("")]
    #[request_header(name = "Idempotency-Key", schema = String, required, description = "Safe retry key")]
    #[request_header(name = "X-API-Key", schema = String, required)]
    #[response(status = 201, body = PaymentDto, headers(("Location", String, "Payment URL")))]
    #[errors(BadRequestException, ConflictException)]
    #[security(Security::BearerAuth)]
    #[security(Security::OAuth2(&["users:read"]))]
    #[security(Security::Custom { name: "TenantAuth", scopes: &[] })]
    async fn create(&self, #[body] payment: PaymentDto) -> Result<Response<PaymentDto>> {
        Ok(Response::WithStatus(caelix::StatusCode::CREATED, payment))
    }

    #[get("/report")]
    #[response(content_type = "application/pdf", headers(("Content-Disposition", String)))]
    async fn report(&self) -> Result<Response<()>> {
        Ok(Response::bytes(caelix::StatusCode::OK, b"pdf".to_vec()))
    }
}

struct DocumentationModule;

impl Module for DocumentationModule {
    fn register() -> ModuleMetadata {
        ModuleMetadata::new().controller::<DocumentationController>()
    }
}

#[caelix::test]
async fn serves_openapi_documentation_with_route_metadata() {
    let app = TestApplication::new::<DocumentationModule>()
        .with_openapi(
            OpenApiConfig::new("Payments", "1.0.0")
                .bearer_auth()
                .api_key_auth("X-API-Key")
                .cookie_auth("session")
                .oauth2(security::OAuth2::new([security::Flow::ClientCredentials(
                    security::ClientCredentials::new(
                        "https://auth.example.test/token",
                        security::Scopes::from_iter([("users:read", "Read users")]),
                    ),
                )]))
                .security_scheme(
                    "TenantAuth",
                    security::SecurityScheme::ApiKey(security::ApiKey::Header(
                        security::ApiKeyValue::new("X-Tenant"),
                    )),
                ),
        )
        .await
        .unwrap();

    let document: Value = app.get("/openapi.json").send().await.unwrap().json().await;
    assert_eq!(document["openapi"], "3.1.0");
    assert_eq!(document["info"]["title"], "Payments");
    let operation = &document["paths"]["/payments"]["post"];
    assert_eq!(operation["requestBody"]["required"], true);
    assert_eq!(operation["parameters"][0]["in"], "header");
    assert_eq!(operation["parameters"][0]["required"], true);
    assert_eq!(
        operation["responses"]["201"]["headers"]["Location"]["description"],
        "Payment URL"
    );
    assert!(operation["responses"].get("400").is_some());
    assert!(operation["responses"].get("409").is_some());
    assert_eq!(
        operation["security"][0]["BearerAuth"],
        serde_json::json!([])
    );
    assert_eq!(
        operation["security"][0]["OAuth2"],
        serde_json::json!(["users:read"])
    );
    assert_eq!(
        operation["security"][0]["TenantAuth"],
        serde_json::json!([])
    );
    assert!(
        document["components"]["schemas"]
            .get("PaymentDto")
            .is_some()
    );
    assert_eq!(
        document["components"]["securitySchemes"]["BearerAuth"]["scheme"],
        "bearer"
    );
    assert_eq!(
        document["components"]["securitySchemes"]["ApiKeyAuth"]["in"],
        "header"
    );
    assert_eq!(
        document["components"]["securitySchemes"]["CookieAuth"]["in"],
        "cookie"
    );
    assert!(
        document["components"]["securitySchemes"]
            .get("OAuth2")
            .is_some()
    );
    assert!(
        document["components"]["securitySchemes"]
            .get("TenantAuth")
            .is_some()
    );
    assert!(
        document["components"]["schemas"]
            .get("ErrorEnvelope")
            .is_some()
    );

    let report = &document["paths"]["/payments/report"]["get"]["responses"]["200"];
    assert!(report["content"]["application/pdf"]["schema"].is_null());
    assert!(report["headers"].get("Content-Disposition").is_some());
    app.get("/docs/")
        .send()
        .await
        .unwrap()
        .assert_status(caelix::StatusCode::OK);
}