[go: up one dir, main page]

schemars 0.8.18

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

mod util;
use schemars::JsonSchema;
use util::*;

#[allow(dead_code)]
#[derive(JsonSchema)]
struct MyStruct {
    #[schemars(skip)]
    skipped1: i32,
    #[serde(skip)]
    skipped2: bool,
    #[serde(skip_deserializing)]
    readable: String,
    #[serde(skip_serializing)]
    writable: f32,
    included: (),
}

#[test]
fn skip_struct_fields() -> TestResult {
    test_default_generated_schema::<MyStruct>("skip_struct_fields")
}

#[allow(dead_code)]
#[derive(JsonSchema)]
struct TupleStruct(
    #[schemars(skip)] i32,
    #[serde(skip)] bool,
    #[serde(skip_deserializing)] String,
    #[serde(skip_serializing)] f32,
    (),
);

#[test]
fn skip_tuple_fields() -> TestResult {
    test_default_generated_schema::<TupleStruct>("skip_tuple_fields")
}

#[derive(JsonSchema)]
pub enum MyEnum {
    #[schemars(skip)]
    Skipped1(i32),
    #[serde(skip)]
    Skipped2,
    #[serde(skip_deserializing)]
    Skipped3,
    #[serde(skip_serializing)]
    Included1(f32),
    Included2,
}

#[test]
fn skip_enum_variants() -> TestResult {
    test_default_generated_schema::<MyEnum>("skip_enum_variants")
}