specta-openapi 0.0.3

Export your Rust types to OpenAPI
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287

//! [OpenAPI](https://www.openapis.org) language exporter for [Specta](specta).
//!
//! <div class="warning">
//! This crate is still in active development and is not yet ready for general purpose use!
//! </div>
//!
#![cfg_attr(docsrs, feature(doc_cfg))]
#![doc(
    html_logo_url = "https://github.com/specta-rs/specta/raw/main/.github/logo-128.png",
    html_favicon_url = "https://github.com/specta-rs/specta/raw/main/.github/logo-128.png"
)]
#![allow(warnings)] // TODO: This crate is still in development

use openapiv3::{
    ArrayType, BooleanType, NumberType, ReferenceOr, Schema, SchemaData, SchemaKind, StringType,
    Type,
};
use specta::datatype::{DataType, Primitive};

// pub fn to_openapi_export(def: &DataType) -> Result<openapiv3::Schema, String> {
//     Ok(match &def {
//         // Named struct
//         // DataType::Struct(StructType {
//         //     name,
//         //     generics,
//         //     fields,
//         //     ..
//         // }) => match fields.len() {
//         //     0 => format!("export type {name} = {inline_ts}"),
//         //     _ => {
//         //         let generics = match generics.len() {
//         //             0 => "".into(),
//         //             _ => format!("<{}>", generics.to_vec().join(", ")),
//         //         };

//         //         format!("export interface {name}{generics} {inline_ts}")
//         //     }
//         // },
//         // // Enum
//         // DataType::Enum(EnumType { name, generics, .. }) => {
//         //     let generics = match generics.len() {
//         //         0 => "".into(),
//         //         _ => format!("<{}>", generics.to_vec().join(", ")),
//         //     };

//         //     format!("export type {name}{generics} = {inline_ts}")
//         // }
//         // // Unnamed struct
//         // DataType::Tuple(TupleType { name, .. }) => {
//         //     format!("export type {name} = {inline_ts}")
//         // }
//         _ => todo!(), // return Err(format!("Type cannot be exported: {:?}", def)),
//     })
// }

macro_rules! primitive_def {
    ($($t:ident)+) => {
        $(DataType::Primitive(Primitive::$t))|+
    }
}

pub fn to_openapi(typ: &DataType) -> ReferenceOr<Schema> {
    let mut schema_data = SchemaData {
        nullable: false,
        deprecated: false, // TODO
        example: None,     // TODO
        title: None,       // TODO
        description: None, // TODO
        default: None,     // TODO
        ..Default::default()
    };

    match &typ {
        // DataType::Any => ReferenceOr::Item(Schema {
        //     schema_data,
        //     schema_kind: SchemaKind::Type(Type::Object(openapiv3::ObjectType::default())), // TODO: Use official "Any Type"
        // }),
        primitive_def!(i8 i16 i32 isize u8 u16 u32 usize f16 f32 f64 f128) => {
            ReferenceOr::Item(Schema {
                schema_data,
                schema_kind: SchemaKind::Type(Type::Number(NumberType::default())), // TODO: Configure number type. Ts: `number`
            })
        }
        primitive_def!(i64 u64 i128 u128) => ReferenceOr::Item(Schema {
            schema_data,
            schema_kind: SchemaKind::Type(Type::Number(NumberType::default())), // TODO: Configure number type. Ts: `bigint`
        }),
        primitive_def!(str char) => ReferenceOr::Item(Schema {
            schema_data,
            schema_kind: SchemaKind::Type(Type::String(StringType::default())), // TODO: Configure string type. Ts: `string`
        }),
        primitive_def!(bool) => ReferenceOr::Item(Schema {
            schema_data,
            schema_kind: SchemaKind::Type(Type::Boolean(BooleanType::default())),
        }),
        // primitive_def!(Never) => "never".into(),
        DataType::Nullable(def) => match to_openapi(def) {
            ReferenceOr::Item(mut schema) => {
                schema.schema_data.nullable = true;
                ReferenceOr::Item(schema)
            }
            reference => reference,
        },
        // DataType::Map(def) => {
        //     format!("Record<{}, {}>", to_openapi(&def.0), to_openapi(&def.1))
        // }
        DataType::List(def) => ReferenceOr::Item(Schema {
            schema_data,
            schema_kind: SchemaKind::Type(Type::Array(ArrayType {
                items: Some(match to_openapi(&def.ty) {
                    ReferenceOr::Item(schema) => ReferenceOr::Item(Box::new(schema)),
                    ReferenceOr::Reference { reference } => ReferenceOr::Reference { reference },
                }),
                // TODO: This type is missing `Default`
                min_items: None,
                max_items: None,
                unique_items: false,
            })),
        }),
        DataType::Tuple(tuple) => match tuple.elements.as_slice() {
            [] => {
                schema_data.nullable = true;
                ReferenceOr::Item(Schema {
                    schema_data,
                    schema_kind: SchemaKind::Type(Type::Object(openapiv3::ObjectType::default())), // TODO: This should be `null` type
                })
            }
            [ty] => to_openapi(ty),
            _tys => todo!(),
        },
        DataType::Struct(s) => {
            let _fields = &s.fields;

            // match &fields[..] {
            //     [] => todo!(), // "null".to_string(),
            //     fields => {
            //         // let mut out = match tag {
            //         //     Some(tag) => vec![format!("{tag}: \"{name}\"")],
            //         //     None => vec![],
            //         // };

            //         // let field_defs = object_fields(fields);

            //         // out.extend(field_defs);

            //         // format!("{{ {} }}", out.join(", "))

            //         ReferenceOr::Item(Schema {
            //             schema_data,
            //             schema_kind: SchemaKind::Type(Type::Object(openapiv3::ObjectType {
            //                 properties: fields
            //                     .iter()
            //                     .map(
            //                         |ObjectField {
            //                              name, ty, optional, ..
            //                          }| {
            //                             (
            //                                 name.clone(),
            //                                 match to_openapi(ty) {
            //                                     ReferenceOr::Item(v) => {
            //                                         ReferenceOr::Item(Box::new(v))
            //                                     }
            //                                     ReferenceOr::Reference { reference } => {
            //                                         ReferenceOr::Reference { reference }
            //                                     }
            //                                 },
            //                             )
            //                         },
            //                     )
            //                     .collect(),
            //                 ..Default::default()
            //             })),
            //         })
            //     }
            // }
            todo!();
        }
        DataType::Enum(_e) => {
            // let variants = e.variants();

            // match &variants[..] {
            //     [] => todo!(), // "never".to_string(),
            //     variants => {
            //         // variants
            //         // .iter()
            //         // .map(|variant| {
            //         //     let sanitised_name = sanitise_name(variant.name());

            //         //     match (repr, variant) {
            //         //         (EnumRepr::Internal { tag }, Variant::Unit(_)) => {
            //         //             format!("{{ {tag}: \"{sanitised_name}\" }}")
            //         //         }
            //         //         (EnumRepr::Internal { tag }, Variant::Unnamed(tuple)) => {
            //         //             let typ = to_openapi(&DataType::Tuple(tuple.clone()));

            //         //             format!("{{ {tag}: \"{sanitised_name}\" }} & {typ}")
            //         //         }
            //         //         (EnumRepr::Internal { tag }, Variant::Named(obj)) => {
            //         //             let mut fields = vec![format!("{tag}: \"{sanitised_name}\"")];

            //         //             fields.extend(object_fields(&obj.fields));

            //         //             format!("{{ {} }}", fields.join(", "))
            //         //         }
            //         //         (EnumRepr::External, Variant::Unit(_)) => {
            //         //             format!("\"{sanitised_name}\"")
            //         //         }
            //         //         (EnumRepr::External, v) => {
            //         //             let ts_values = to_openapi(&v.data_type());

            //         //             format!("{{ {sanitised_name}: {ts_values} }}")
            //         //         }
            //         //         (EnumRepr::Untagged, Variant::Unit(_)) => "null".to_string(),
            //         //         (EnumRepr::Untagged, v) => to_openapi(&v.data_type()),
            //         //         (EnumRepr::Adjacent { tag, .. }, Variant::Unit(_)) => {
            //         //             format!("{{ {tag}: \"{sanitised_name}\" }}")
            //         //         }
            //         //         (EnumRepr::Adjacent { tag, content }, v) => {
            //         //             let ts_values = to_openapi(&v.data_type());

            //         //             format!("{{ {tag}: \"{sanitised_name}\", {content}: {ts_values} }}")
            //         //         }
            //         //     }
            //         // })
            //         // .collect::<Vec<_>>()
            //         // .join(" | ");

            //         ReferenceOr::Item(Schema {
            //             schema_data,
            //             schema_kind: SchemaKind::AnyOf {
            //                 any_of: variants
            //                     .iter()
            //                     .map(|variant| match variant {
            //                         EnumVariants::Unit(_) => ReferenceOr::Item(Schema {
            //                             schema_data: Default::default(),
            //                             schema_kind: SchemaKind::Type(Type::Object(
            //                                 openapiv3::ObjectType::default(), // TODO: Is this correct?
            //                             )),
            //                         }),
            //                         EnumVariants::Unnamed(tuple) => {
            //                             to_openapi(&DataType::Tuple(tuple.clone()))
            //                         }
            //                         Variant::Named(obj) => {
            //                             to_openapi(&DataType::Struct(obj.clone()))
            //                         }
            //                     })
            //                     .collect(),
            //             },
            //         })
            //     }
            // }

            todo!();
        }
        DataType::Reference(_reference) => {
            todo!();
            // match &reference.generics()[..] {
            //     [] => {
            //         todo!();
            //         // ReferenceOr::Item(Schema {
            //         //     schema_data,
            //         //     schema_kind: SchemaKind::OneOf {
            //         //         one_of: vec![ReferenceOr::Reference {
            //         //             reference: format!("#/components/schemas/{}", reference.name()),
            //         //         }],
            //         //     },
            //         // })
            //     }
            //     generics => {
            //         // let generics = generics
            //         //     .iter()
            //         //     .map(to_openapi)
            //         //     .collect::<Vec<_>>()
            //         //     .join(", ");

            //         // format!("{name}<{generics}>")
            //         todo!();
            //     }
            // }
        }
        // DataType::Generic(ident) => ident.to_string(),
        x => {
            println!("{:?} {:?}", x, typ);
            todo!();
        }
    }
}