Kā izmantot JSON shēmu datu validēšanai
Kas ir JSON shēma?
JSON shēma ir standartizēta metode, kā aprakstīt JSON datu struktūru, nepieciešamās lauku prasības un vērtību tipus. To var uzskatīt par līgumu vai plānu, kas nosaka, kāda izskatīties derīgai JSON datnei. JSON shēma ir rakstīta pašā JSON formātā, padarot to gan mašīnlasāmu, gan viegli rediģējamu.
Kāpēc validēt ar shēmu?
- Novērst kļūdas, savlaicīgi atklājot nederīgus vai trūkstošus datus.
- Nodrošināt datu konsekvenci starp komandām, lietotnēm vai API.
- Automātiski ģenerēt dokumentāciju no shēmām.
- Palīdzēt redaktoriem un rīkiem nodrošināt labāku automātisko pabeigšanu un iebūvētu palīdzību.
Vienkāršs piemērs: bāzes shēma
Šeit ir pamata JSON objekts un tam piemērota minimāla shēma, kas pārbauda tā struktūru:
{
"name": "Alice",
"age": 30
}
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "number" }
},
"required": ["name", "age"]
}
Šī shēma nodrošina, ka objektam obligāti jābūt laukam 'name' (teksta tips) un 'age' (skaitļa tips).
Kā uzrakstīt pielāgotu shēmu
Jūs varat definēt sarežģītākas prasības shēmā: ierobežot lauka vērtības, izveidot iekšējos objektus vai noteikt minimālo/maksimālo skaitļu vērtību. Šeit ir piemērs, kas pārbauda produktu masīvu:
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"price": { "type": "number", "minimum": 0 },
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["id", "price"]
}
}
Kā izmantot JSONValidator.dev shēmu validēšanai
- Ielīmējiet savu JSON datni galvenajā redaktorā.
- Ielīmējiet savu JSON shēmu zem shēmu redaktora.
- Noklikšķiniet uz Validēt JSON pret šo shēmu.
- Pārskatiet validācijas rezultātus — kļūdas būs izceltas un paskaidrotas.
Kā novērst shēmu validācijas kļūdas
Biežākie validācijas kļūdu iemesli ir:
- Jūsu datos trūkst kāds obligāts lauks.
- Vērtības datu tips neatbilst shēmas prasībām (piemēram, teksts vietā, kur vajadzīgs skaitlis).
- Shēma pati ir nederīga vai satur drukas kļūdas.
Secinājums
JSON shēmas validācija ir spēcīgs veids, kā padarīt jūsu datus stabilus un bez kļūdām. Izmēģiniet izveidot shēmu saviem datiem ar mūsu bezmaksas JSON Schema Generator un validējiet to tiešsaistē!