Introduction to JavaScript Object Notation: A To-the-Point Guide to JSON (English Edition)

はじめに

JSON Schemaとは?

前述の通り、JSON Schemaは、

JSONの構造を定義したものです。

また、JSON SchemaはJSONの構造を、

JSONファイルとして定義します。

例えば、下記のようなJSONファイルがあったとします。

f:id:meison_amsl:20190512172957p:plain

json_schema_sample/sample.json at master · AtsushiSakai/json_schema_sample · GitHub

このJSONファイルのJSON schemaは、

下記のようになります。

f:id:meison_amsl:20190512173058p:plain

json_schema_sample/json.schema at master · AtsushiSakai/json_schema_sample · GitHub

JSON schemaでは、

フィールドの型(文字列や数値、配列など)を定義したり、

必ず必要なフィールドを指定したり、

フィールドの配列の個数や、

フィールドの数値の範囲なども定義することができます。

またpatternのタグを使うことで、正規表現を使って、

JSONのフィールドが定義を満たしているかを確認することができます。

使用できるタグに関しては、下記を参照してください。

Azure CosmosDBでJSON Schema Validationを使ってJSON検証してみる|ネスケラボ

このJSON Schemaを使うことで、

JSONファイルが正しい構造になっているのかを

自動的に確認(Validate)したり、

JSONデータのドキュメントを生成したりすることができます。

JSONファイルからJSON Schemaを生成する

すでに、Schemaの元となるJSONファイルが手元にある場合は、

そのJSONファイルから、JSON Schemaを生成できると便利です。

下記のWebツールは、

ブラウザからJSONデータを元に、

JSON Schemaを生成することができます。

JSON Schema Tool

また、CLIのツールとしては、

下記のPythonライブラリを使うことで、

JSON schemaを生成することも可能です。

(メンテされていないように見えますが。。)

perenecabuto/json_schema_generator: A simple json schema generator from any json source

JSON SchemaでJSONをvalidateする

JSON schemaのデータ構造を元に、

JSONデータのチェックをするのが、

JSON schemaのメインの用途です。

JSON schemaによるJSONのvalidateするツールは色々ありますが、

Implementations | JSON Schema

代表的なものとしては、

下記のようなPython製のライブラリがあります。

下記のコードは、

実際にJSONファイルとJSON schemaファイルを読み込んで、

jsonschemaでvalidateするサンプルコードです。

""" 

json schema validate sample

author: Atsushi Sakai

"""

from jsonschema import validate
import json


def main():
    print("start!!")

    f = open("sample.json")
    jsond = json.load(f)
    f.close()
    print("JSON data:")
    print(jsond)

    f = open("json.schema")
    schema = json.load(f)
    f.close()

    print("JSON schema:")
    print(schema)


    # OK 
    validate(instance=jsond, schema=schema)

    # NG
    validate(instance={"name" : "Eggs", "price" : 34.99}, schema=schema)

    print("done!!")


if __name__ == '__main__':
    main()