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
121
122
123
124
125
126
127

#[test]
fn merge_same_path_diff_methods() {
    let mut api_1 = OpenApiBuilder::new()
        .info(Info::new("Api", "v1"))
        .paths(
            crate::openapi::PathsBuilder::new()
                .path(
                    "/api/v1/user",
                    PathItem::new(
                        HttpMethod::Get,
                        OperationBuilder::new()
                            .response("200", Response::new("Get user success 1")),
                    ),
                )
                .extensions(Some(Extensions::from_iter([("x-v1-api", true)])))
                .build(),
        )
        .build();

    let api_2 = OpenApiBuilder::new()
        .info(Info::new("Api", "v2"))
        .paths(
            crate::openapi::PathsBuilder::new()
                .path(
                    "/api/v1/user",
                    PathItem::new(
                        HttpMethod::Get,
                        OperationBuilder::new()
                            .response("200", Response::new("This will not get added")),
                    ),
                )
                .path(
                    "/api/v1/user",
                    PathItem::new(
                        HttpMethod::Post,
                        OperationBuilder::new()
                            .response("200", Response::new("Post user success 1")),
                    ),
                )
                .path(
                    "/api/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("Post user success 2")),
                    ),
                )
                .extensions(Some(Extensions::from_iter([("x-random", "Value")])))
                .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()
    });
}

#[test]
fn test_nest_open_apis() {
    let api = OpenApiBuilder::new()
        .paths(crate::openapi::PathsBuilder::new().path(
            "/api/v1/status",
            PathItem::new(
                HttpMethod::Get,
                OperationBuilder::new().description(Some("Get status")).build(),
            ),
        ))
        .build();

    let user_api = OpenApiBuilder::new()
        .paths(
            crate::openapi::PathsBuilder::new()
                .path(
                    "/",
                    PathItem::new(
                        HttpMethod::Get,
                        OperationBuilder::new()
                            .description(Some("Get user details"))
                            .build(),
                    ),
                )
                .path(
                    "/foo",
                    PathItem::new(HttpMethod::Post, OperationBuilder::new().build()),
                ),
        )
        .build();

    let nest_merged = api.nest("/api/v1/user", user_api);
    let value = serde_json::to_value(nest_merged).expect("should serialize as json");
    let paths = value.pointer("/paths").expect("paths should exits in openapi");

    assert_json_snapshot!(paths);
}

#[test]
fn openapi_custom_extension() {
    let mut api = OpenApiBuilder::new().build();
    let extensions = api.extensions.get_or_insert(Default::default());
    extensions.insert(
        String::from("x-tagGroup"),
        String::from("anything that serializes to Json").into(),
    );

    assert_json_snapshot!(api);
}