Jak używać JSON Schema do walidacji danych
Czym jest JSON Schema?
JSON Schema to ustandaryzowany sposób opisu struktury, wymaganych pól oraz typów wartości w twoich danych JSON. Można to porównać do umowy lub planu, który określa, jak powinien wyglądać prawidłowy plik JSON. JSON Schema jest napisany w formacie JSON, co sprawia, że jest zarówno czytelny dla maszyn, jak i łatwy do edycji.
Dlaczego warto walidować przy pomocy schematu?
- Zapobiega błędom poprzez wykrywanie nieprawidłowych lub brakujących danych, zanim spowodują problemy.
- Zachowuje spójność danych pomiędzy zespołami, aplikacjami czy interfejsami API.
- Automatycznie generuje dokumentację na podstawie schematów.
- Pomaga edytorom i narzędziom oferować lepsze podpowiedzi i pomoc kontekstową.
Prosty przykład: podstawowy schemat
Oto podstawowy obiekt JSON oraz minimalny schemat, który sprawdza jego strukturę:
{
"name": "Alice",
"age": 30
}
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "number" }
},
"required": ["name", "age"]
}
Ten schemat zapewnia, że obiekt musi zawierać pole „name” (string) oraz „age” (liczba).
Jak napisać własny schemat
Możesz definiować zaawansowane reguły w swoim schemacie: ograniczać wartości pól, definiować zagnieżdżone obiekty lub ustawiać minimalne/maksymalne wartości liczb. Oto przykład walidujący tablicę produktów:
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"price": { "type": "number", "minimum": 0 },
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["id", "price"]
}
}
Jak korzystać z JSONValidator.dev do walidacji schematów
- Wklej swoje dane JSON w głównym edytorze.
- Wklej schemat JSON w edytorze schematów poniżej.
- Kliknij Waliduj JSON względem tego schematu.
- Przejrzyj wyniki walidacji, z podkreślonymi i objaśnionymi błędami.
Rozwiązywanie problemów z błędami walidacji schematu
Najczęstsze przyczyny błędów walidacji to:
- Brakuje wymaganego pola w danych.
- Typ wartości nie zgadza się ze schematem (np. string zamiast liczby).
- Schemat jest niepoprawny lub zawiera literówki.
Podsumowanie
Walidacja za pomocą JSON Schema to potężny sposób, by uczynić dane solidnymi i odpornymi na błędy. Spróbuj stworzyć schemat dla własnych danych z naszym bezpłatnym Generatorem JSON Schema i sprawdź go na żywo!