Gå til indhold

JSON Schema Generator

Generér et JSON-skema ud fra eksempel-JSON. Generatoren udleder typer, påkrævede egenskaber, skemaer for arrayelementer og almindelige strengformater som date-time, email, uri og uuid og skriver et skema til draft 2020-12, 2019-09 eller draft-07, som du kan bruge til at validere forespørgsler, dokumentere et API eller generere formularer.

Nulstil

Ofte stillede spørgsmål

Hvilke JSON Schema-drafts understøttes?

Draft 2020-12, den aktuelle version, som OpenAPI 3.1 bruger, draft 2019-09 og draft-07, som mange ældre validatorer og værktøjer stadig forventer. Valget angiver $schema-URL; nøgleordene, som generatoren skriver, betyder det samme i alle tre.

Hvordan afgøres det, hvilke egenskaber der er påkrævede?

En egenskab angives under required, når den findes i hvert eksempel på det pågældende objekt. I et array af objekter udelades en nøgle, der mangler i nogle elementer, fra required. Slå indstillingen fra for at skrive et skema uden lister over påkrævede egenskaber.

Hvilke strengformater registreres?

date-time, date, time, email, uri, uuid og ipv4. Et format tilføjes kun, når alle eksempelværdier for egenskaben matcher det, så én enkelt værdi med fri tekst holder egenskaben som en almindelig streng. Slå registrering fra, hvis du ikke ønsker formatnøgleord.

Skelner skemaet mellem heltal og decimaltal?

Ja. En egenskab, hvis eksempler alle er hele tal, får typen integer. Så snart ét eksempel har en decimaldel, bliver typen number, som også accepterer heltal.

Hvordan beskrives arrays?

Et array får typen array og et items-skema, der er bygget ud fra alle dets elementer samlet. Objekter i et array flettes sammen, så items-skemaet angiver hver nøgle, der forekommer i et element, mens required kun omfatter nøgler, der forekommer i dem alle.

Hvad sker der med blandede typer?

Når en egenskab indeholder simple værdier af forskellige typer, f.eks. en streng i ét element og null i et andet, angiver skemaet dem som et typearray, f.eks. ["string", "null"]. Når objekter eller arrays blandes med andre typer, bruger generatoren anyOf med ét skema for hver.

Tilføjer den additionalProperties eller begrænsninger?

Nej. Et eksempel kan ikke vise, hvilke ekstra nøgler der er forbudt, eller hvad de reelle minimums- og maksimumsværdier er, så generatoren udelader additionalProperties, minLength, maximum og lignende nøgleord. Tilføj dem manuelt, hvor dine data kræver det.

Kan jeg validere data med resultatet?

Ja. Indsæt skemaet og dine data i JSON Schema Validator, eller brug det med et bibliotek som Ajv. Kontrollér først skemaet: Det afspejler dit eksempel, så et felt, der kan mangle eller være null i rigtige data, men ikke i eksemplet, kræver en lille redigering.

Kan jeg bruge skemaet i OpenAPI?

OpenAPI 3.1 bruger JSON Schema 2020-12 direkte, så det genererede schema kan placeres under components/schemas, når du har fjernet linjen $schema. OpenAPI 3.0 bruger et ældre undersæt; dér skal type-arrays erstattes med nullable.

Hvor stort kan input være?

Op til 1,000,000 tegn af JSON, indlejret i op til 64 niveauer. Eksemplet analyseres kun for denne anmodning og gemmes ikke.

Om OneClick Pro

OneClick Pro er en gratis samling med mere end 150 webværktøjer til daglige opgaver: konvertering af billeder og enheder, formatering og validering af kode, opslag af domæner og SEO samt arbejde med tekst, datoer og tal. Alle værktøjer fungerer uden registrering eller abonnement, og det, du indtaster, bruges kun til at beregne resultatet og gemmes aldrig. Brug samlingen som en hurtig værktøjskasse til enkeltstående opgaver, eller bogmærk de værktøjer, du bruger hver dag.