JSON-schema till TypeScript
Konvertera ett JSON-schema till TypeScript-typer. Objekt blir gränssnitt med obligatoriska och valfria egenskaper, $defs och definitioner blir namngivna exporter som $ref pekar på, enum och const blir literaltyper, anyOf och oneOf blir unioner och allOf blir en skärning. Beskrivningar bevaras som dokumentationskommentarer.
Vanliga frågor
Vilka JSON Schema-utkast stöds?
Konverteraren läser nyckelorden som delas av draft-07, 2019-09 och 2020-12: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf och $ref till $defs eller definitions. Valideringsnyckelord som minLength eller pattern saknar motsvarighet i TypeScript och utelämnas.
Hur löses $ref-referenser?
Referenser till #, #/$defs/Name och #/definitions/Name blir den namngivna typen för den definitionen. Alla andra referenser, till exempel till en annan fil eller en URL, typas som unknown och listas i en kommentar överst i resultatet.
Hur hanteras additionalProperties?
Ett objekt utan egenskaper och med ett additionalProperties-schema blir Record<string, T>. Ett objekt med egenskaper och ett additionalProperties-schema blir gränssnittet sammanslaget med Record<string, T>. additionalProperties false eller ett saknat nyckelord lägger inte till något, eftersom TypeScript-objekttyper redan beskriver de kända nycklarna.
Vad gör nullable?
Nyckelordet nullable: true i OpenAPI 3.0 och Swagger-tillägget x-nullable lägger till | null i typen. I själva JSON-schemat skriver du type: ["string", "null"], vilket blir string | null.
Stöds rekursiva scheman?
Ja. En definition som refererar till sig själv eller till en annan definition via $ref blir en namngiven typ som refererar till det andra namnet, vilket TypeScript löser utan problem.
Kontrollerar verktyget att mitt schema är giltigt?
Det läser endast schemat. Okända nyckelord ignoreras och ett schema utan type blir unknown. Använd JSON-schema-validatorn för att kontrollera data mot ett schema.