JSON sémagenerátor
Készítsen JSON sémát egy mintabeli JSON alapján. A generátor következtet a típusokra, a kötelező tulajdonságokra, a tömbelemek sémáira és az olyan gyakori szövegformátumokra, mint a date-time, email, uri és uuid, majd a draft 2020-12, 2019-09 vagy draft-07 változathoz ír sémát. Ezzel ellenőrizheti a kéréseket, dokumentálhat egy API-t vagy űrlapokat generálhat.
Gyakran ismételt kérdések
Mely JSON séma-változatokat támogatja?
A draft 2020-12-es változatot, amelyet az OpenAPI 3.1 használ, a draft 2019-09-et és a draft-07-et, amelyet sok régebbi validátor és eszköz még elvár. A választás határozza meg a $schema URL-t; a generátor mindhárom változatban azonos jelentésű kulcsszavakat ír.
Hogyan állapítja meg a kötelező tulajdonságokat?
Egy tulajdonság akkor kerül a required listába, ha az adott objektum minden mintájában szerepel. Objektumok tömbje esetén a némelyik elemből hiányzó kulcs nem kerül a required listába. Kapcsolja ki ezt a beállítást, ha required lista nélküli sémát szeretne.
Mely szövegformátumokat ismeri fel?
date-time, date, time, email, uri, uuid és ipv4. A rendszer csak akkor ad hozzá formátumot, ha az adott tulajdonság minden mintabeli értéke megfelel neki, így egyetlen szabad szöveges érték esetén a tulajdonság egyszerű string marad. Kapcsolja ki a felismerést, ha nem szeretne formátumkulcsszavakat.
Megkülönbözteti a séma az egész számokat a tizedesektől?
Igen. Ha egy tulajdonság minden mintabeli értéke egész szám, a típusa integer lesz. Amint egyetlen mintában is van törtrész, a típusa number lesz, amely az egész számokat is elfogadja.
Hogyan írja le a tömböket?
A tömb típusa array lesz, az items sémája pedig az összes elem együttes vizsgálata alapján készül. A tömbben lévő objektumok összevonásra kerülnek, így az items séma minden olyan kulcsot felsorol, amely bármelyik elemben előfordul; a required listába csak az összes elemben szereplő kulcsok kerülnek.
Mi történik vegyes típusok esetén?
Ha egy tulajdonság különböző egyszerű értéktípusokat tartalmaz, például az egyik elemben stringet, egy másikban pedig null értéket, a séma type tömbként sorolja fel ezeket, például ["string", "null"]. Ha objektumok vagy tömbök keverednek más típusokkal, a generátor az egyes típusokhoz tartozó sémákat tartalmazó anyOf elemet használ.
Hozzáad additionalProperties beállítást vagy korlátozásokat?
Nem. Egy minta alapján nem állapítható meg, mely további kulcsok tiltottak, illetve mennyi a tényleges minimum és maximum, ezért a generátor kihagyja az additionalProperties, minLength, maximum és hasonló kulcsszavakat. Adja hozzá őket kézzel, ha az adatai megkövetelik.
Ellenőrizhetem az eredménnyel az adatokat?
Igen. Illessze be a sémát és az adatokat a JSON sémavalidátorba, vagy használja egy olyan könyvtárral, mint az Ajv. Előbb ellenőrizze a sémát: az a mintát tükrözi, ezért ha a valós adatokban egy mező hiányozhat vagy null lehet, de a mintában nem ilyen, kisebb módosításra lesz szükség.
Használhatom a sémát OpenAPI-ban?
Az OpenAPI 3.1 közvetlenül használja a JSON Schema 2020-12-t, így a létrehozott séma a components/schemas alá kerülhet, miután eltávolítja a $schema sort. Az OpenAPI 3.0 egy régebbi részhalmazt használ; ott a típus tömböket nullable értékkel helyettesítse.
Mekkora lehet a bemenet?
Legfeljebb 1,000,000 karakter JSON, legfeljebb 64 szint mélységig beágyazva. A mintát csak ehhez a kéréshez elemzi a rendszer, és nem tárolja.