Typ TypeScript na JSON Schema
Konwertuj interfejs lub alias typu TypeScript na JSON Schema.
Typ TypeScript na JSON Schema
Wklej interfejs lub alias typu TypeScript a to narzędzie wygeneruje równoważny JSON Schema, gotowy do walidacji ładunków API, plików konfiguracyjnych lub innych danych JSON, które powinny odpowiadać twoim definicjom typów. Jest budowane dla programistów, którzy już opisują kształty swoich danych w TypeScript i chcą schemat bez ręcznego pisania lub zaangażowania kroku budowy.
Wybierz między JSON Schema draft-07 a nowszym dialektem 2020-12, ponieważ walidatory i narzędzia wciąż różnią się tym, których się spodziewają. Unia łańcuchów jak 'active' | 'inactive' może renderować się jako enum lub jako anyOf wartości const, a możesz wymagać od obiektów odrzucenia nieznanych właściwości, konwersji komentarzy dokumentacji na pola opisu lub wyodrębnienia nazwanych interfejsów do bloku $defs (lub definitions) przywoływanego przez $ref zamiast osadzania ich wszędzie, gdzie się używają.
Tablice, krotki, Record i Map typy oraz unii zawierające null są obsługiwane w taki sposób, jak naprawdę je używa TypeScript — pole dopuszczające null staje się tablicą typów lub gałęzią anyOf, a nie cichym pominięciem. Konstrukcje bez ekwiwalentu w JSON Schema, takie jak metody, typy funkcji lub nierozwiązane parametry generyczne, są konwertowane tak permisywnie, jak to możliwe, i wymieniane jako ostrzeżenia pod wynikiem, aby nic nie zawiodło w ciszy.
Wszystko działa lokalnie w przeglądarce; twoje definicje typów i wygenerowany JSON Schema nigdy nie są nigdzie przesyłane. Skopiuj wynik, pobierz go jako plik .txt lub wyślij go bezpośrednio do wejścia innego narzędzia, aby kontynuować pracę.