Hur du använder JSON Schema för att validera dina data
Vad är ett JSON Schema?
Ett JSON Schema är ett standardiserat sätt att beskriva strukturen, obligatoriska fält och datatyper i dina JSON-data. Tänk på det som ett kontrakt eller en ritning för hur giltig JSON skall se ut. JSON Schema skrivs i JSON, vilket gör det både maskinläsbart och enkelt att redigera.
Varför validera med ett schema?
- Förebygga buggar genom att upptäcka ogiltiga eller saknade data innan de orsakar problem.
- Säkerställa datakonsekvens mellan olika team, applikationer eller API:er.
- Generera dokumentation automatiskt utifrån scheman.
- Hjälpa redigerare och verktyg att ge bättre automatisk komplettering och inbyggd hjälp.
Ett enkelt exempel: Grundläggande schema
Här är ett grundläggande JSON-objekt, följt av ett minimalt schema som validerar dess struktur:
{
"name": "Alice",
"age": 30
}
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "number" }
},
"required": ["name", "age"]
}
Detta schema säkerställer att objektet måste ha ett "name" (som en sträng) och en "age" (som ett nummer).
Hur du skriver ett eget schema
Du kan definiera avancerade regler i ditt schema: begränsa värden, definiera nästlade objekt eller sätta minimi-/maximivärden. Här är ett exempel som validerar en lista av produkter:
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"price": { "type": "number", "minimum": 0 },
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["id", "price"]
}
}
Använda JSONValidator.dev för schema-validering
- Klistra in din JSON-data i huvudedigeraren.
- Klistra in ditt JSON Schema i schemaeditorn nedanför.
- Klicka på Validera JSON mot detta schema.
- Granska valideringsresultaten, med eventuella fel markerade och förklarade.
Felsökning av schema-valideringsfel
Vanliga orsaker till valideringsfel är:
- Ett obligatoriskt fält saknas i dina data.
- En datatyp stämmer inte överens med schemat (t.ex. sträng kontra nummer).
- Schemat i sig är ogiltigt eller innehåller stavfel.
Slutsats
JSON Schema-validering är ett kraftfullt sätt att göra dina data robusta och felfria. Prova att skapa ett schema för dina egna data med vår kostnadsfria JSON Schema-generator och validera det direkt!