PythonでJSONスキーマを使用してデータを検証する

Pythonでは、JSONスキーマを使用してJSON形式のデータを検証することができます。これは、通信データのチェックを一から組むのではなく、チェックの設定とデータを与えるとチェックを実行してくれる仕組みを利用することで、プログラムや装置に悪影響を及ぼさないようにするためのものです。

JSONスキーマとは

JSONスキーマは、JSON形式のデータをチェックするためのスキーマを作成し、Pythonで読み込んでチェックする方法を提供します。スキーマは、データの型や必須フィールド、オプションフィールドなどを定義します。

JSONスキーマの作成

以下に、簡単なJSONスキーマの例を示します。

schema = {
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "PyJsonValidate",
    "description": "sample json for json validate",
    "type": "object",
    "properties" :{
        "name": {
            "type": "string"
        },
        "age": {
            "type": "integer"
        }
    },
    "required": ["name"]
}

このスキーマは、対象のJSONがオブジェクトであり、nameとageという2つのプロパティを持つことを指定しています。また、nameプロパティは必須であることを指定しています。

Pythonでのデータチェック

Pythonのjsonschemaライブラリを使用して、作成したJSONスキーマファイルを読み込み、サンプルデータのチェックを行います。

import json
from jsonschema import validate, ValidationError

with open('schema.json') as file_obj:
    json_schema = json.load(file_obj)

item = {
    "name": "tama",
}

try:
    validate(item, json_schema)
except ValidationError as e:
    print(e.message)

このコードは、schema.jsonという名前のJSONスキーマファイルを読み込み、itemという名前のサンプルデータをチェックします。validate関数は、サンプルデータがスキーマに適合しているかどうかをチェックし、適合していない場合はValidationErrorをスローします。

以上が、PythonでJSONスキーマを使用してデータを検証する基本的な方法です。これにより、データの整合性を保つことができ、データ処理の効率を向上させることができます。