Generator de scheme JSON
Generați o schemă JSON din date de exemplu JSON. Generatorul deduce tipurile, proprietățile obligatorii, schemele elementelor din tablouri și formatele uzuale de șiruri, precum date-time, email, uri și uuid, apoi scrie o schemă pentru draftul 2020-12, 2019-09 sau draft-07, pe care o puteți folosi pentru a valida solicitări, a documenta un API sau a genera formulare.
Întrebări frecvente
Ce drafturi de schemă JSON sunt acceptate?
Draftul 2020-12, versiunea actuală folosită de OpenAPI 3.1, draftul 2019-09 și draft-07, pe care multe validatoare și instrumente mai vechi încă le așteaptă. Alegerea stabilește $schema URL; cuvintele-cheie scrise de generator au același înțeles în toate cele trei versiuni.
Cum sunt stabilite proprietățile obligatorii?
O proprietate este inclusă la required când apare în fiecare exemplu al obiectului respectiv. Într-un tablou de obiecte, o cheie care lipsește din unele elemente nu este inclusă la required. Dezactivați opțiunea pentru a genera o schemă fără liste required.
Ce formate de șiruri sunt detectate?
date-time, date, time, email, uri, uuid și ipv4. Un format este adăugat doar dacă toate valorile de exemplu ale proprietății respective corespund formatului, astfel că o singură valoare în text liber păstrează proprietatea ca șir simplu. Dezactivați detectarea dacă nu doriți cuvinte-cheie pentru formate.
Schema distinge numerele întregi de cele zecimale?
Da. O proprietate ale cărei exemple sunt toate numere întregi primește tipul integer. Dacă un singur exemplu are o parte fracționară, tipul devine number, care acceptă și numere întregi.
Cum sunt descrise tablourile?
Un tablou primește tipul array și o schemă items construită din toate elementele sale. Obiectele dintr-un tablou sunt combinate, astfel că schema items enumeră toate cheile întâlnite în oricare element, iar required include doar cheile prezente în toate.
Ce se întâmplă cu tipurile mixte?
Când o proprietate conține valori simple de tipuri diferite, cum ar fi un șir de caractere într-un element și null în altul, schema le enumeră într-un tablou de tipuri, de exemplu ["string", "null"]. Când obiectele sau tablourile sunt combinate cu alte tipuri, generatorul folosește anyOf cu câte o schemă pentru fiecare.
Adaugă additionalProperties sau limite?
Nu. Un exemplu nu poate arăta ce chei suplimentare sunt interzise sau care sunt valorile reale minime și maxime, așa că generatorul omite additionalProperties, minLength, maximum și cuvinte-cheie similare. Adăugați-le manual acolo unde datele dvs. au nevoie de ele.
Pot valida date cu rezultatul?
Da. Lipiți schema și datele dvs. în JSON Schema Validator sau folosiți-o cu o bibliotecă precum Ajv. Verificați mai întâi schema: aceasta reflectă exemplul dvs., așa că un câmp care poate lipsi sau poate avea valoarea null în datele reale, dar nu și în exemplu, necesită o mică modificare.
Pot folosi schema în OpenAPI?
OpenAPI 3.1 folosește direct Schema JSON2020-12, astfel încât schema generată poate fi plasată sub components/schemas după ce eliminați linia $schema. OpenAPI 3.0 folosește un subset mai vechi; în acest caz, înlocuiți tablourile de tipuri cu nullable.
Cât de mare poate fi intrarea?
Până la 1,000,000 caractere de JSON, imbricate pe cel mult 64 de niveluri. Exemplul este analizat doar pentru această solicitare și nu este stocat.