satay-codegen 0.12.1

Generate Rust client code from OpenAPI 3.1 documents
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
153
154
155
156
157
158

use super::*;

#[test]
fn lowers_tags_to_ordered_api_groups_and_shortens_local_method_names() {
    let api = parse_valid(
        r#"
openapi: 3.1.0
info:
  title: Grouped API
  version: 1.0.0
tags:
  - name: realtime
    description: Realtime views.
  - name: bus
    description: Bus operations.
paths:
  /arrival:
    get:
      operationId: getBusArrival
      tags: [bus, realtime]
      responses:
        '204':
          description: No content
  /stops:
    get:
      operationId: listBusStops
      tags: [bus]
      responses:
        '204':
          description: No content
  /arrival-direct:
    get:
      operationId: getArrival
      tags: [bus]
      responses:
        '204':
          description: No content
  /health:
    get:
      operationId: health
      responses:
        '204':
          description: No content
"#,
    );

    assert_eq!(api.operations[0].tags, ["bus", "realtime"]);
    assert_eq!(api.operations[1].tags, ["bus"]);
    assert!(api.operations[3].tags.is_empty());

    assert_eq!(
        api.groups
            .iter()
            .map(|group| group.rust_name.as_str())
            .collect::<Vec<_>>(),
        ["realtime", "bus", "untagged"]
    );

    let realtime = group(&api, "realtime");
    assert_eq!(realtime.wire_name.as_deref(), Some("realtime"));
    assert_eq!(realtime.description.as_deref(), Some("Realtime views."));
    assert_eq!(group_methods(realtime), ["get_bus_arrival"]);

    let bus = group(&api, "bus");
    assert_eq!(bus.description.as_deref(), Some("Bus operations."));
    assert_eq!(
        group_methods(bus),
        ["get_arrival", "list_stops", "get_arrival_2"]
    );

    let untagged = group(&api, "untagged");
    assert_eq!(untagged.wire_name, None);
    assert_eq!(group_methods(untagged), ["health"]);
}

#[test]
fn group_names_avoid_root_module_and_api_method_collisions() {
    let api = parse_valid(
        r#"
openapi: 3.1.0
info:
  title: Group collisions
  version: 1.0.0
tags:
  - name: api
  - name: base-url
  - name: get-user
  - name: bus-service
  - name: bus_service
paths:
  /user:
    get:
      operationId: getUser
      tags: [api, base-url, get-user, bus-service, bus_service]
      responses:
        '204':
          description: No content
  /untagged:
    get:
      operationId: untagged
      responses:
        '204':
          description: No content
"#,
    );

    assert_eq!(
        api.groups
            .iter()
            .map(|group| group.rust_name.as_str())
            .collect::<Vec<_>>(),
        [
            "api_2",
            "base_url_2",
            "get_user_2",
            "bus_service",
            "bus_service_2",
            "untagged_2",
        ]
    );
}

#[test]
fn resanitizes_operation_names_after_removing_the_group_name() {
    let api = parse_valid(
        r#"
openapi: 3.1.0
info:
  title: Group method sanitization
  version: 1.0.0
paths:
  /type:
    get:
      operationId: getType
      tags: [get]
      responses:
        '204':
          description: No content
"#,
    );

    assert_eq!(group_methods(group(&api, "get")), ["type_"]);
}

fn group<'a>(api: &'a Api, rust_name: &str) -> &'a crate::model::ApiGroup {
    api.groups
        .iter()
        .find(|group| group.rust_name == rust_name)
        .unwrap_or_else(|| panic!("missing API group {rust_name}"))
}

fn group_methods(group: &crate::model::ApiGroup) -> Vec<&str> {
    group
        .operations
        .iter()
        .map(|operation| operation.method_name.as_str())
        .collect()
}