xidlc 0.41.0

A IDL codegen.
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

#[test]
fn serialize_deserialize_openapi_version_success() -> Result<(), serde_json::Error> {
    assert_eq!(serde_json::to_value(&OpenApiVersion::Version31)?, "3.1.0");
    Ok(())
}

#[test]
fn serialize_openapi_json_minimal_success() {
    let openapi = OpenApi::new(
        InfoBuilder::new()
            .title("My api")
            .version("1.0.0")
            .description(Some("My api description"))
            .license(Some(
                LicenseBuilder::new()
                    .name("MIT")
                    .url(Some("http://mit.licence"))
                    .build(),
            ))
            .build(),
        Paths::new(),
    );

    assert_json_snapshot!(openapi);
}

#[test]
fn serialize_openapi_json_with_paths_success() {
    let openapi = OpenApi::new(
        Info::new("My big api", "1.1.0"),
        PathsBuilder::new()
            .path(
                "/api/v1/users",
                PathItem::new(
                    HttpMethod::Get,
                    OperationBuilder::new().response("200", Response::new("Get users list")),
                ),
            )
            .path(
                "/api/v1/users",
                PathItem::new(
                    HttpMethod::Post,
                    OperationBuilder::new().response("200", Response::new("Post new user")),
                ),
            )
            .path(
                "/api/v1/users/{id}",
                PathItem::new(
                    HttpMethod::Get,
                    OperationBuilder::new().response("200", Response::new("Get user by id")),
                ),
            ),
    );

    assert_json_snapshot!(openapi);
}

#[test]
fn merge_2_openapi_documents() {
    let mut api_1 = OpenApi::new(
        Info::new("Api", "v1"),
        PathsBuilder::new()
            .path(
                "/api/v1/user",
                PathItem::new(
                    HttpMethod::Get,
                    OperationBuilder::new().response("200", Response::new("Get user success")),
                ),
            )
            .build(),
    );

    let api_2 = OpenApiBuilder::new()
        .info(Info::new("Api", "v2"))
        .paths(
            PathsBuilder::new()
                .path(
                    "/api/v1/user",
                    PathItem::new(
                        HttpMethod::Get,
                        OperationBuilder::new()
                            .response("200", Response::new("This will not get added")),
                    ),
                )
                .path(
                    "/ap/v2/user",
                    PathItem::new(
                        HttpMethod::Get,
                        OperationBuilder::new()
                            .response("200", Response::new("Get user success 2")),
                    ),
                )
                .path(
                    "/api/v2/user",
                    PathItem::new(
                        HttpMethod::Post,
                        OperationBuilder::new().response("200", Response::new("Get user success")),
                    ),
                )
                .build(),
        )
        .components(Some(
            ComponentsBuilder::new()
                .schema(
                    "User2",
                    ObjectBuilder::new().schema_type(Type::Object).property(
                        "name",
                        ObjectBuilder::new().schema_type(Type::String).build(),
                    ),
                )
                .build(),
        ))
        .build();

    api_1.merge(api_2);

    assert_json_snapshot!(api_1, {
        ".paths" => insta::sorted_redaction()
    });
}