JSON Schema

JSON Schema は、JSON ドキュメントに注釈を付け、検証できるようにする語彙です。JSON データの契約を提供し、構造、データ型、検証ルールを定義します。

Apidog は JSON Schema を使用してリクエストおよびレスポンスのボディ構造を定義し、API の自動検証とドキュメント生成を可能にします。

外部参照

このページでは、JSON Schema について簡単に紹介します。完全な仕様の詳細、構文、高度な機能については、公式の JSON Schema Documentation を参照してください。

JSON Schema とは何ですか？

JSON Schema は、以下を行うための強力なツールです。

定義されたルールに基づく JSON データの検証

期待される JSON 構造の ドキュメント化

スキーマ定義に基づくモックデータの生成

API リクエストおよびレスポンス全体での 一貫性の確保

POST/PUT/PATCH エンドポイントのリクエストボディスキーマを定義する

すべての HTTP メソッドのレスポンスボディ構造を指定する

受信データを期待される形式に照らして検証する

モックレスポンスを自動生成する

包括的な API ドキュメントを作成する

JSON Schema の構文、検証キーワード、高度な機能に関する詳細情報については、公式の JSON Schema Specification Documents を参照してください。

まずは基本型と必須フィールドを定義するシンプルなスキーマから始め、必要に応じて検証ルールや制約を徐々に追加してください。