概要 - Apidog Docs

OpenAPI Specification (OAS) における基本概念であるスキーマは、データモデルとも一般的に呼ばれます。スキーマは、API のリクエストおよびレスポンスオブジェクトに期待されるデータ型とプロパティを定義します。

JSON Schema は、Apidog が API で使用されるデータ構造をモデル化するために採用している標準です。

スキーマを使用すると、次のことができます。

標準的なデータ構造（Order オブジェクトなど）を定義する。

自動生成された例とスキーマを統合する。

API プロジェクト全体でデータ構造を繰り返し活用する。

Apidog におけるスキーマの目的

Apidog では、スキーマは次の点で重要な役割を果たします。

目的	説明
API の設計	設計段階の早期にスキーマを定義することで、開発者は API が扱うデータ構造を可視化し、改善できます。
サービスのモック	Apidog は定義されたスキーマを利用してモックレスポンスを生成し、実際の実装前であっても、開発者が API の動作やフロントエンドとの連携をシミュレートできるようにします。
ドキュメント	スキーマに基づいて正確かつ包括的な API ドキュメントが自動生成され、期待されるデータ形式や構造について API 利用者との明確なコミュニケーションを促進します。
デバッグ	スキーマは API デバッグ時にレスポンスを検証するために使用され、API レスポンスが定義されたデータモデルに準拠していることを保証します。

スキーマの適用範囲を検討してください。そのデータは複数の API セクションや API 全体で利用されますか、それとも単一のユースケースに固有のものですか。

データ構造を複数の用途で使用することを意図している場合、スキーマを作成することで一元管理と一貫性の確保が容易になります。

「Schemas」 ディレクトリの下でスキーマを追加できます。

Apidog の使いやすいスキーマエディターを活用して、JSON Schema 仕様に準拠したスキーマを効果的に構築できます。

再利用可能なスキーマを作成したら、エンドポイントに移動し、リクエストまたはレスポンスのボディ、あるいは他のスキーマ内でそのスキーマを参照します。共有データモデルを参照することで、API 設計のさまざまなコンポーネント全体で一貫性を維持し、データモデルの統合を効率化できます。