Pereiti prie turinio

JSON schemos generatorius

Sugeneruokite JSON schemą iš pavyzdinio JSON. Generatorius nustato tipus, privalomas savybes, masyvo elementų schemas ir įprastus eilučių formatus, tokius kaip date-time, email, uri ir uuid, tada sukuria draft 2020-12, 2019-09 arba draft-07 schemą, kurią galite naudoti užklausoms tikrinti, API dokumentuoti arba formoms generuoti.

Nustatyti iš naujo

Dažnai užduodami klausimai

Kurios JSON schemos versijos palaikomos?

Draft 2020-12 – dabartinė versija, kurią naudoja OpenAPI 3.1, taip pat draft 2019-09 ir draft-07, kurių vis dar tikisi daugelis senesnių tikrintuvų ir įrankių. Pasirinkus nustatoma $schema URL versija; generatoriaus įrašomi raktažodžiai visose trijose versijose reiškia tą patį.

Kaip nustatomos privalomos savybės?

Savybė įtraukiama į required, jei ji yra kiekviename to objekto pavyzdyje. Objektų masyve raktas, kurio trūksta kai kuriuose elementuose, į required neįtraukiamas. Išjunkite šią parinktį, kad schema būtų kuriama be jokių required sąrašų.

Kokie eilučių formatai aptinkami?

date-time, date, time, email, uri, uuid ir ipv4. Formatas pridedamas tik tada, kai kiekviena tos savybės pavyzdinė reikšmė jį atitinka, todėl viena laisvo teksto reikšmė palieka savybę paprasta eilute. Išjunkite aptikimą, jei nenorite formato raktažodžių.

Ar schema atskiria sveikuosius ir dešimtainius skaičius?

Taip. Jei visi savybės pavyzdžiai yra sveikieji skaičiai, tipas nustatomas kaip integer. Kai tik viename pavyzdyje atsiranda trupmeninė dalis, tipas tampa number, kuris taip pat apima sveikuosius skaičius.

Kaip aprašomi masyvai?

Masyvui nustatomas tipas array, o jo items schema sudaroma iš visų elementų kartu. Masyve esantys objektai sujungiami, todėl items schemoje nurodomi visi bet kuriame elemente esantys raktai, o required apima tik tuos, kurie yra visuose elementuose.

Kas nutinka esant mišriems tipams?

Kai savybėje yra skirtingų tipų paprastos reikšmės, pavyzdžiui, viename elemente eilutė, o kitame null, schema jas išvardija kaip tipų masyvą, pavyzdžiui, ["string", "null"]. Kai objektai arba masyvai maišomi su kitais tipais, generatorius naudoja anyOf ir kiekvienam tipui pateikia atskirą schemą.

Ar pridedamos additionalProperties arba ribos?

Ne. Iš pavyzdžio neįmanoma nustatyti, kurie papildomi raktai draudžiami ir kokios yra tikrosios mažiausios bei didžiausios reikšmės, todėl generatorius neįtraukia additionalProperties, minLength, maximum ir panašių raktažodžių. Pridėkite juos rankiniu būdu ten, kur to reikia jūsų duomenims.

Ar galiu tikrinti duomenis naudodamas rezultatą?

Taip. Įklijuokite schemą ir savo duomenis į JSON schemos tikrintuvą arba naudokite ją su biblioteka, pavyzdžiui, Ajv. Pirmiausia patikrinkite schemą: ji atspindi jūsų pavyzdį, todėl reikės ją šiek tiek pakoreguoti, jei realiuose duomenyse laukas gali trūkti arba būti null, bet pavyzdyje taip nėra.

Ar galiu naudoti schemą OpenAPI?

OpenAPI 3.1 naudoja JSON Schema 2020-12 tiesiogiai, todėl sugeneruotą schemą galima įdėti į components/schemas, pašalinus $schema eilutę. OpenAPI 3.0 naudoja senesnį poaibį; jame tipų masyvus pakeiskite į nullable.

Kokio dydžio gali būti įvestis?

Iki 1,000,000 JSON simbolių, įdėtinumas – iki 64 lygių. Pavyzdys analizuojamas tik šiai užklausai ir nėra saugomas.

Apie OneClick Pro

OneClick Pro – nemokama kolekcija, kurioje yra daugiau nei 150 žiniatinklio įrankių kasdieniam darbui: vaizdams ir vienetams konvertuoti, kodui formatuoti ir tikrinti, domenams ir SEO tikrinti, taip pat tekstui, datoms ir skaičiams apdoroti. Visi įrankiai veikia be registracijos ar prenumeratos, o jūsų įvesti duomenys naudojami tik rezultatui apskaičiuoti ir niekada neišsaugomi. Naudokite juos kaip greitą įrankių rinkinį vienkartinėms užduotims arba įtraukite į žymes įrankius, kurių prireikia kasdien.