Vad gör JSON Schema-generatorn?

Den skapar ett JSON Schema åt dig utifrån ett exempel på dina data. Klistra in ett exempel, till exempel ett API-svar, en konfigurationsfil eller en post från en databasexport, så får du ett schema som beskriver strukturen: typen för varje värde, egenskaperna för varje objekt, hur elementen i varje array ser ut och vilka egenskaper som krävs. Det är en snabb start för API-dokumentation, OpenAPI-specifikationer, formulärvalidering eller datakontrakt, som du sedan kan finjustera manuellt.

Så här använder du verktyget

  1. Klistra in eller skriv exempel-JSON i inmatningsrutan.
  2. Välj utkast av JSON Schema för raden $schema: Draft 2020-12 eller Draft 7.
  3. Välj om egenskaper ska markeras som obligatoriska.
  4. Kopiera schemat eller ladda ner det som schema.json.

Om exemplet inte är giltig JSON anger verktyget rad och kolumn för felet och markerar det.

Så här skapas schemat

  • Varje värde får sin JSON-typ: string, boolean, null, object, array och integer för heltal eller number för decimaltal. En array med heltal och decimaltal får typen number, som omfattar båda.
  • För varje nyckel i objekt läggs en post till under properties, beskriven på samma sätt, så djupt som exemplet sträcker sig.
  • För arrayer skapas ett items-schema som passar alla element. Om elementen är objekt slås deras egenskaper ihop, så en lista med poster ger ett schema för en post.
  • Värden med blandade typer får alla typer i en lista, till exempel ["string", "null"], eller en anyOf när objekt blandas med andra värden.
  • En tom array får "type": "array" utan items, eftersom det inte finns något att beskriva.

Obligatoriska egenskaper

När "Markera egenskaper som obligatoriska" är aktiverat listas varje objekts nycklar under required. För en array med objekt är en egenskap obligatorisk endast om varje element har den: i en medlemslista där bara vissa har en favorite är den egenskapen valfri. Stäng av alternativet för att få ett schema utan required-listor.

Vad ett exempel inte kan visa

Ett schema som skapats från ett enda exempel känner bara till det som exemplet visar. Det kan inte veta vilka strängvärden som är e-postadresser eller datum, vilka intervall tal kan ha eller att en egenskap som förekommer en gång också kan saknas. Lägg till format, minimum, maxLength, enum eller pattern manuellt där det behövs, och kontrollera data mot resultatet med JSON Schema Validator.

Så fungerar det

Verktyget använder genson-js, en JavaScript-port av schemabyggaren GenSON. Nyckelorden som verktyget skriver har samma betydelse i Draft 7 och Draft 2020-12, så utkastet ändrar bara raden $schema. Allt körs i din webbläsare: exemplet laddas aldrig upp.

Funktioner

  • JSON Schema från valfritt JSON-exempel
  • Typer, nästlade objekt och arrayer identifieras automatiskt
  • Arrayelement slås ihop till ett schema, och valfria egenskaper identifieras
  • Draft 2020-12 eller Draft 7
  • Obligatoriska egenskaper kan aktiveras eller inaktiveras
  • Kopiera eller ladda ner som schema.json
  • Körs i din webbläsare