Sådan bruger du JSON Schema til at validere dine data
Hvad er et JSON Schema?
Et JSON Schema er en standardiseret måde at beskrive strukturen, obligatoriske felter og værdityper i dine JSON-data på. Forestil dig det som en kontrakt eller en køreplan for, hvordan gyldig JSON skal se ud. JSON Schema er skrevet i JSON selv, hvilket gør det både maskinlæsbart og nemt at redigere.
Hvorfor validere med et schema?
- Forebyg fejl ved at opdage ugyldige eller manglende data, inden de skaber problemer.
- Sikre datakonsistens på tværs af teams, apps eller API’er.
- Automatisk generere dokumentation ud fra skemaer.
- Hjælpe editorer og værktøjer med bedre autofuldførelse og indbygget hjælp.
Et simpelt eksempel: Grundlæggende schema
Her er et grundlæggende JSON-objekt efterfulgt af et minimalt schema, der validerer dets struktur:
{
"name": "Alice",
"age": 30
}
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "number" }
},
"required": ["name", "age"]
}
Dette schema sikrer, at objektet skal have et 'name' (som en string) og en 'age' (som et tal).
Sådan skriver du et tilpasset schema
Du kan definere avancerede regler i dit schema: begrænse feltværdier, definere indlejrede objekter eller sætte minimums-/maksimumsværdier. Her er et eksempel, der validerer et array af produkter:
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"price": { "type": "number", "minimum": 0 },
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["id", "price"]
}
}
Brug af JSONValidator.dev til schema-validering
- Indsæt dine JSON-data i hovededitoren.
- Indsæt dit JSON Schema i schema-editoren nedenfor.
- Klik på Valider JSON mod dette schema.
- Gennemgå valideringsresultaterne med fejl fremhævet og forklaret.
Fejlfinding af schema-valideringsfejl
Almindelige årsager til valideringsfejl inkluderer:
- Et påkrævet felt mangler i dine data.
- En værditype passer ikke til schemaet (f.eks. string vs. number).
- Schemaet selv er ugyldigt eller indeholder fejl.
Konklusion
JSON Schema-validering er en effektiv måde at gøre dine data robuste og fejlsikre på. Prøv at lave et schema til dine egne data med vores gratis JSON Schema Generator og valider det live!