Schemat JSON do TypeScript
Konwertuj schemat JSON na typy TypeScript. Obiekty stają się interfejsami z wymaganymi i opcjonalnymi właściwościami. $defs i definicje stają się nazwanymi eksportami, do których odwołuje się $ref. enum i const stają się typami literałowymi, anyOf i oneOf stają się uniami, a allOf — przecięciem. Opisy są zachowywane jako komentarze dokumentacyjne.
Najczęściej zadawane pytania
Które wersje robocze schematu JSON są obsługiwane?
Konwerter odczytuje słowa kluczowe wspólne dla draft-07, 2019-09 i 2020-12: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf oraz $ref do $defs lub definitions. Słowa kluczowe dotyczące walidacji, takie jak minLength lub pattern, nie mają odpowiednika TypeScript i są pomijane.
Jak rozwiązywane są odwołania $ref?
Odwołania do #, #/$defs/Name i #/definitions/Name stają się nazwanym typem danej definicji. Każde inne odwołanie, na przykład do innego pliku lub URL, otrzymuje typ unknown i jest wymieniane w komentarzu na początku wyniku.
Jak obsługiwane jest additionalProperties?
Obiekt bez właściwości, ale ze schematem additionalProperties, staje się Record<string, T>. Obiekt z właściwościami i schematem additionalProperties staje się interfejsem połączonym z Record<string, T>. additionalProperties false lub brak tego słowa kluczowego niczego nie dodaje, ponieważ typy obiektów TypeScript już opisują znane klucze.
Co robi nullable?
Słowo kluczowe nullable: true z OpenAPI 3.0 i rozszerzenie Swagger x-nullable dodają | null do typu. W samym schemacie JSON zapisz type: ["string", "null"], co staje się string | null.
Czy obsługiwane są schematy rekurencyjne?
Tak. Definicja odwołująca się do samej siebie lub do innej definicji przez $ref staje się nazwanym typem, który odwołuje się do drugiej nazwy; TypeScript rozwiązuje to bez problemów.
Czy narzędzie sprawdza, czy mój schemat jest prawidłowy?
Narzędzie tylko odczytuje schemat. Nieznane słowa kluczowe są ignorowane, a schemat bez typu staje się unknown. Użyj walidatora schematów JSON, aby sprawdzić dane względem schematu.