JSON Schema-generator

Vad JSON Schema-generatorn gör

JSON Schema-generatorn läser ett JSON-exempel och skapar ett draft-07-schema som validerar dokument med samma struktur. Den går rekursivt igenom värdet: objekt blir ett schema med en properties-karta och en required-array, arrayer blir ett schema med en items-definition, och primitiva värden beskrivs med sin JSON Schema-type. Resultatet är ett portabelt kontrakt som du kan använda i API-dokumentation, valideringsmellanprogram för anrop, konfigurationsinläsare, kontraktstester eller editorverktyg som erbjuder autokomplettering och inbäddad validering utifrån ett schema.

Arrayer sammanfattas i stället för att räknas upp. När en array innehåller objekt slås alla element ihop så att det genererade items-schemat täcker unionen av nycklar, och en nyckel som saknas i vissa element tas bort från listan över obligatoriska fält. När en array blandar primitiva typer skapar generatorn ett anyOf så att varje observerad typ förblir giltig. Att generera utifrån ett exempel är det snabbaste sättet att få fram ett schema som du sedan finjusterar för hand, i stället för att skriva nästlade typdefinitioner från grunden.

Privat arbetsflöde i webbläsaren

All tolkning och schemabygge sker i din webbläsare med JavaScript på klientsidan. Verktyget laddar inte upp din JSON, dina API-svar, konfiguration, identifierare eller kundliknande exempel till någon server och kräver inget konto. Det rent lokala beteendet är viktigt eftersom indata till en schemagenerator ofta är en verklig nyttolast som fångats vid felsökning av en tjänst. Att behålla arbetet på din dator minskar riskerna och gör resultatet omedelbart eftersom inget lämnar sidan.

Gränssnittet visar JSON-indata och det genererade schemat sida vid sida så att du kan kontrollera resultatet innan du kopierar det. Ett schema som genererats från ett enda exempel är en startpunkt, inte ett färdigt kontrakt: ett enskilt exempel kan inte avslöja alla valfria egenskaper, enum-värden, formatbegränsningar eller talintervall som din domän tillåter, så vidga och skärp schemat med kunskap som exemplet inte innehåller.

Praktiska tips

Använd det mest kompletta exemplet du har, med ifyllda valfria fält och arrayer med fler än ett element, så att sammanslagningslogiken kan beskriva unioner korrekt. Finjustera schemat efter genereringen: lägg till format-nyckelord som email, uri eller date-time där det passar, lägg till enum-listor för fält med en fast uppsättning värden, ange minimum och maximum för tal och ta bort fält som legitimt kan saknas ur required-arrayen. Validera det slutliga schemat mot flera verkliga dokument med valfri validerare innan du använder det i produktion, eftersom generering i webbläsaren är bäst för ett snabbt och träffsäkert första utkast.