Jak sprawdzić, czy JSON zawiera poprawne pola?

Istnieje kilka podejść:

1. Sprawdzanie obecności pól: Iterować po oczekiwanych polach i sprawdzać ich obecność w JSON.

   import json
   
   def check_json_fields(json_string, expected_fields):
       try:
           data = json.loads(json_string)
           for field in expected_fields:
               if field not in data:
                   return False, f"Brak pola '{field}'"
           return True, "Wszystkie oczekiwane pola są obecne"
       except json.JSONDecodeError:
           return False, "Niepoprawny JSON"
       except Exception as e:
           return False, f"Błąd: {e}"
   
   # Przykład użycia
   json_data = '{"name": "Alice", "age": 30}'
   expected = ["name", "age", "city"]
   result, message = check_json_fields(json_data, expected)
   print(result, message) # False Brak pola 'city'
   
   json_data_valid = '{"name": "Bob", "age": 25}'
   expected_valid = ["name", "age"]
   result_valid, message_valid = check_json_fields(json_data_valid, expected_valid)
   print(result_valid, message_valid) # True Wszystkie oczekiwane pola są obecne
   

2. Użycie JSON Schema: JSON Schema to słownik służący do walidacji struktury JSON. Jest to najbardziej niezawodne i elastyczne podejście do złożonych struktur.

   from jsonschema import validate, SchemaError
   
   # Schemat do walidacji JSON
   schema = {
       "type": "object",
       "properties": {
           "name": {"type": "string"},
           "age": {"type": "integer", "minimum": 0},
           "city": {"type": "string"}
       },
       "required": ["name", "age"] # Pola obowiązkowe
   }
   
   def validate_json_with_schema(json_data, schema):
       try:
           validate(instance=json_data, schema=schema)
           return True, "JSON zgodny ze schematem"
       except SchemaError as e:
           return False, f"Błąd schematu: {e.message}"
       except Exception as e:
           return False, f"Błąd walidacji: {e.message}"
   
   # Przykład
   valid_data = {"name": "Alice", "age": 30, "city": "New York"}
   result_valid, message_valid = validate_json_with_schema(valid_data, schema)
   print(result_valid, message_valid) # True JSON zgodny ze schematem
   
   invalid_data = {"name": "Bob"} # Brak 'age'
   result_invalid, message_invalid = validate_json_with_schema(invalid_data, schema)
   print(result_invalid, message_invalid) # False Błąd walidacji: 'age' jest wymaganym polem
   
   invalid_type_data = {"name": "Charlie", "age": "twenty"} # Niepoprawny typ
   result_type_invalid, message_type_invalid = validate_json_with_schema(invalid_type_data, schema)
   print(result_type_invalid, message_type_invalid) # False Błąd walidacji: 'twenty' nie jest typu 'integer'
   

3. Użycie bibliotek do sprawdzania typów i struktury: Niektóre języki mają biblioteki, które pozwalają na bardziej deklaratyjne określenie struktury danych.

   • Python: Pydantic, Marshmallow.
   • JavaScript: Joi, Yup.

4. Pisanie własnych funkcji walidacyjnych: Dla specyficznych przypadków lub złożonej logiki można napisać własne funkcje walidacji.

Wybór metody zależy od złożoności struktury JSON, wymagań dotyczących rygoru kontroli i używanego stosu technologicznego. JSON Schema jest najbardziej zalecanym podejściem, aby zapewnić niezawodność i wsparcie.