schemars 1.2.1

Generate JSON Schemas from Rust code
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

use crate::prelude::*;
use std::collections::BTreeMap;

#[derive(JsonSchema, Deserialize, Serialize, Default)]
struct Flat {
    f: f32,
    b: bool,
    #[serde(default, skip_serializing_if = "str::is_empty")]
    s: String,
    v: Vec<i32>,
}

#[derive(JsonSchema, Deserialize, Serialize, Default)]
#[schemars(rename = "Flat")]
struct Deep1 {
    f: f32,
    #[serde(flatten)]
    deep2: Deep2,
    v: Vec<i32>,
}

#[derive(JsonSchema, Deserialize, Serialize, Default)]
struct Deep2 {
    b: bool,
    #[serde(flatten, skip_serializing_if = "Option::is_none")]
    deep3: Option<Deep3>,
}

#[derive(JsonSchema, Deserialize, Serialize)]
struct Deep3 {
    s: String,
}

#[test]
fn flattened_struct() {
    test!(Deep1)
        .assert_snapshot()
        .assert_identical::<Flat>()
        .assert_allows_ser_roundtrip([
            Deep1::default(),
            Deep1 {
                f: 1.0,
                deep2: Deep2 {
                    b: true,
                    deep3: Some(Deep3 {
                        s: "test".to_owned(),
                    }),
                },
                v: vec![123],
            },
        ])
        .assert_matches_de_roundtrip(arbitrary_values());
}

#[derive(JsonSchema, Deserialize, Serialize, Default)]
struct FlattenValue {
    flag: bool,
    #[serde(flatten)]
    value: Value,
}

#[derive(JsonSchema, Deserialize, Serialize, Default)]
#[schemars(rename = "FlattenValue")]
struct FlattenMap {
    flag: bool,
    #[serde(flatten)]
    value: BTreeMap<String, Value>,
}

#[test]
fn flattened_value() {
    test!(FlattenValue)
        .assert_snapshot()
        .assert_allows_ser_roundtrip([
            FlattenValue {
                flag: false,
                value: Value::Null,
            },
            FlattenValue {
                flag: true,
                value: Value::Object(Default::default()),
            },
        ])
        .assert_matches_de_roundtrip(arbitrary_values());
}

#[test]
fn flattened_map() {
    test!(FlattenMap)
        .assert_identical::<FlattenValue>()
        .assert_allows_ser_roundtrip_default()
        .assert_matches_de_roundtrip(arbitrary_values());
}