gotcha 0.4.0

Enhanced web framework built on top of Axum with OpenAPI, metrics, and configuration management
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

//! `#[validate(...)]` constraints (from the validator crate) are mirrored into the OpenAPI schema,
//! so a rule written once for runtime validation also documents the field:
//! `range` (incl. exclusive bounds) → minimum/maximum (+ exclusiveMinimum/Maximum),
//! `length` (min/max/equal) → minLength/maxLength (minItems/maxItems for collections),
//! `email`/`url` → format. Unmodelled validators (`regex`, `custom`, …) are silently skipped.

use gotcha::{Schematic, Validate};
use serde::{Deserialize, Serialize};

#[derive(Schematic, Serialize, Deserialize, Validate)]
struct CreateUser {
    #[validate(length(min = 1, max = 64))]
    name: String,
    #[validate(email)]
    email: String,
    #[validate(range(min = 0, max = 150))]
    age: u8,
    #[validate(range(exclusive_min = 0, exclusive_max = 10))]
    ratio: u8,
    #[validate(length(min = 1, max = 5))]
    tags: Vec<String>,
    #[validate(length(equal = 3))]
    code: String,
}

fn main() {
    let schema = serde_json::to_value(CreateUser::generate_schema().schema).unwrap();
    let props = &schema["properties"];

    // `length` on a string → minLength / maxLength.
    assert_eq!(props["name"]["minLength"], 1);
    assert_eq!(props["name"]["maxLength"], 64);

    // `email` → format.
    assert_eq!(props["email"]["format"], "email");

    // `range` → minimum / maximum.
    assert_eq!(props["age"]["minimum"], 0.0);
    assert_eq!(props["age"]["maximum"], 150.0);

    // Exclusive bounds → minimum/maximum + exclusiveMinimum/Maximum (the OpenAPI 3.0 form).
    assert_eq!(props["ratio"]["minimum"], 0.0);
    assert_eq!(props["ratio"]["exclusiveMinimum"], true);
    assert_eq!(props["ratio"]["maximum"], 10.0);
    assert_eq!(props["ratio"]["exclusiveMaximum"], true);

    // `length` on a collection → minItems / maxItems.
    assert_eq!(props["tags"]["minItems"], 1);
    assert_eq!(props["tags"]["maxItems"], 5);

    // `length(equal = ..)` fixes both bounds.
    assert_eq!(props["code"]["minLength"], 3);
    assert_eq!(props["code"]["maxLength"], 3);
}