Pāriet uz saturu

JSON shēmas ģenerators

Ģenerējiet JSON shēmu no parauga JSON. Ģenerators nosaka tipus, obligātos rekvizītus, masīvu elementu shēmas un izplatītus virkņu formātus, piemēram, date-time, email, uri un uuid, kā arī izveido draft 2020-12, 2019-09 vai draft-07 shēmu, ko varat izmantot pieprasījumu validēšanai, API dokumentēšanai vai veidlapu ģenerēšanai.

Atiestatīt

Bieži uzdotie jautājumi

Kuras JSON shēmas draft versijas tiek atbalstītas?

Draft 2020-12 — pašreizējā versija, ko izmanto OpenAPI 3.1 —, draft 2019-09 un draft-07, ko joprojām sagaida daudzi vecāki validatori un rīki. Izvēle nosaka $schema URL; visās trijās ģeneratora rakstītajiem atslēgvārdiem ir viena un tā pati nozīme.

Kā tiek noteikti obligātie rekvizīti?

Rekvizīts tiek iekļauts sadaļā required, ja tas ir katrā šī objekta paraugā. Objektu masīvā atslēga, kuras trūkst dažos elementos, netiek iekļauta sadaļā required. Izslēdziet šo opciju, lai izveidotu shēmu bez obligāto rekvizītu sarakstiem.

Kādi virkņu formāti tiek noteikti?

date-time, date, time, email, uri, uuid un ipv4. Formāts tiek pievienots tikai tad, ja tam atbilst visas šī rekvizīta parauga vērtības; viena brīvā teksta vērtība atstāj rekvizītu kā parastu virkni. Izslēdziet noteikšanu, ja nevēlaties formāta atslēgvārdus.

Vai shēmā tiek nošķirti veseli un decimālskaitļi?

Jā. Rekvizītam, kura visas parauga vērtības ir veseli skaitļi, piešķir tipu integer. Tiklīdz kādai parauga vērtībai ir daļdaļa, tips kļūst par number, kas pieņem arī veselus skaitļus.

Kā tiek aprakstīti masīvi?

Masīvam piešķir tipu array un vienumu shēmu, kas izveidota, kopīgi aplūkojot visus tā elementus. Masīvā esošie objekti tiek apvienoti, tāpēc vienumu shēmā ir visas atslēgas, kas sastopamas kaut vienā elementā, bet required ietver tikai tās atslēgas, kas ir visos elementos.

Kas notiek, ja tipi ir jaukti?

Ja rekvizītam ir vienkāršas dažādu tipu vērtības, piemēram, vienā elementā virkne, bet citā null, shēmā tās norāda kā tipu masīvu, piemēram, ["string", "null"]. Ja objekti vai masīvi ir jaukti ar citiem tipiem, ģenerators izmanto anyOf ar atsevišķu shēmu katram tipam.

Vai tiek pievienoti additionalProperties vai ierobežojumi?

Nē. Paraugs nevar parādīt, kuras papildu atslēgas ir aizliegtas vai kādas ir īstās minimālās un maksimālās vērtības, tāpēc ģenerators neiekļauj additionalProperties, minLength, maximum un līdzīgus atslēgvārdus. Pievienojiet tos manuāli vietās, kur to prasa jūsu dati.

Vai ar rezultātu varu validēt datus?

Jā. Ielīmējiet shēmu un datus JSON shēmas validatorā vai izmantojiet tos ar bibliotēku, piemēram, Ajv. Vispirms pārbaudiet shēmu: tā atspoguļo jūsu paraugu, tāpēc nelielas izmaiņas vajadzīgas laukam, kas reālajos datos var trūkt vai būt null, bet paraugā tā nav.

Vai shēmu var izmantot OpenAPI?

OpenAPI 3.1 izmanto JSON Schema 2020-12 tieši, tāpēc ģenerēto shēmu var ievietot sadaļā components/schemas pēc $schema rindas noņemšanas. OpenAPI 3.0 izmanto vecāku apakškopu; tajā aizstājiet tipu masīvus ar nullable.

Cik liels var būt ievades apjoms?

Līdz 1,000,000 rakstzīmēm JSON, ligzdojot līdz 64 līmeņiem. Paraugs tiek analizēts tikai šim pieprasījumam un netiek saglabāts.

Par OneClick Pro

OneClick Pro ir bezmaksas vairāk nekā 150 tīmekļa rīku kolekcija ikdienas darbam: attēlu un mērvienību konvertēšanai, koda formatēšanai un validēšanai, domēnu un SEO pārbaudei, kā arī darbam ar tekstu, datumiem un skaitļiem. Katru rīku var izmantot bez reģistrācijas vai abonēšanas, un ievadītie dati tiek izmantoti tikai rezultāta aprēķināšanai un nekad netiek saglabāti. Izmantojiet to kā ātru rīku kopumu atsevišķiem uzdevumiem vai pievienojiet grāmatzīmēm rīkus, ko lietojat katru dienu.