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
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
149
150
151
152

use crate::prelude::*;

#[derive(JsonSchema, Deserialize, Serialize, Default)]
struct UnitStruct;

#[test]
fn unit() {
    test!(UnitStruct)
        .assert_snapshot()
        .assert_allows_ser_roundtrip_default()
        .assert_matches_de_roundtrip(arbitrary_values());
}

#[derive(JsonSchema, Deserialize, Serialize, Default)]
struct NormalStruct {
    foo: String,
    bar: bool,
}

#[test]
fn normal() {
    test!(NormalStruct)
        .assert_snapshot()
        .assert_allows_ser_roundtrip_default()
        .assert_allows_de_roundtrip([json!({
            "foo": "",
            "bar": true,
            "unknown": 123
        })])
        .assert_matches_de_roundtrip(arbitrary_values());
}

#[derive(JsonSchema, Deserialize, Serialize, Default)]
struct NewType(String);

#[test]
fn newtype() {
    test!(NewType)
        .assert_snapshot()
        .assert_allows_ser_roundtrip_default()
        .assert_matches_de_roundtrip(arbitrary_values());
}

#[derive(JsonSchema, Deserialize, Serialize, Default)]
struct TupleStruct(String, bool);

#[test]
fn tuple() {
    test!(TupleStruct)
        .assert_snapshot()
        .assert_allows_ser_roundtrip_default()
        .assert_matches_de_roundtrip(arbitrary_values());
}

#[derive(JsonSchema, Deserialize, Serialize, Default)]
#[serde(rename_all = "camelCase")]
struct RenamedFields {
    camel_case: i32,
    #[serde(rename = "new_name")]
    old_name: i32,
}

#[test]
fn renamed_fields() {
    test!(RenamedFields)
        .assert_snapshot()
        .assert_allows_ser_roundtrip_default()
        .assert_matches_de_roundtrip(arbitrary_values());
}

#[derive(JsonSchema, Deserialize, Serialize, Default)]
#[serde(deny_unknown_fields)]
struct DenyUnknownFields {
    foo: String,
    bar: bool,
}

#[test]
fn deny_unknown_fields() {
    test!(DenyUnknownFields)
        .assert_snapshot()
        .assert_allows_ser_roundtrip_default()
        .assert_rejects_de([json!({
            "foo": "",
            "bar": true,
            "unknown": 123
        })])
        .assert_matches_de_roundtrip(arbitrary_values());
}

#[derive(JsonSchema, Deserialize, Serialize, Default)]
#[schemars(example = PropertyOrder::default(), extend("x-custom" = PropertyOrder::default()))]
struct PropertyOrder {
    #[serde(rename = "$defs")]
    pub defs: UnitStruct,
    pub examples: UnitStruct,
    pub properties: UnitStruct,
    pub required: UnitStruct,
    #[serde(rename = "$schema")]
    pub schema: UnitStruct,
    pub title: UnitStruct,
    pub r#type: UnitStruct,
    #[serde(rename = "x-custom")]
    pub x_custom: UnitStruct,
}

#[cfg_attr(not(feature = "preserve_order"), ignore)]
#[test]
fn property_order() {
    test!(PropertyOrder).assert_snapshot().custom(|schema, _| {
        fn get_property_keys(value: &Value) -> Vec<&str> {
            value
                .as_object()
                .expect("expected value to be an object")
                .keys()
                .map(String::as_str)
                .collect()
        }

        let value = serde_json::to_value(schema).unwrap();

        assert!(matches!(
            get_property_keys(&value).as_slice(),
            // order of `examples`, `required` and `x-custom` is unspecified
            &["$schema", "title", "type", "properties", .., "$defs"]
        ));

        let field_order = &[
            "$defs",
            "examples",
            "properties",
            "required",
            "$schema",
            "title",
            "type",
            "x-custom",
        ];

        assert_eq!(
            get_property_keys(&value["properties"]).as_slice(),
            field_order,
        );
        assert_eq!(
            get_property_keys(&value["examples"][0]).as_slice(),
            field_order,
        );
        assert_eq!(
            get_property_keys(&value["x-custom"]).as_slice(),
            field_order,
        );
    });
}