Schema / データモデル

Schema

ApidogのSchemaは、あらゆるプログラミング言語のSchemaに似ています。主にAPI 設計のResponseとBodyパラメータ(json/xml 形式)に使用されます。

JSON/XMLから生成

JSONデータからデータ構造を自動的に生成することをサポートします。すでにJSONデータを持っている場合、簡単にデータ構造を生成できます。

ご案内：

JSONスマート認識はデータ構造のみ生成します、JSON 内の値は保存されません。

Schemaの編集

1. フィールドが必須項目であるかどうかを選択します。
2. フィールドのデータタイプを選択します。
3. Mockフィールドを編集します。Mockの構文の詳細に関するドキュメントを参照する。
4. 新しいフィールドを追加したり、既存フィールドを削除したりすることができます。
5. フィールドをドラッグしてドロップすると、その順番を変えることができます。
6. フィールドの指示の記入におけるより効率的な方法ただいま開発中です。お楽しみに！

データ構造

Schemaは再利用可能なデータ構造です。新しいデータ構造を構築するときは、データタイプで既存のSchemaを直接選択できます。

Schemaの管理

Schemaを構築する前に、まずは再利用可能なデータ構造を構築する必要があります。下記のスクリーンショットで示すように、Schemaセクションで新しいデータ構造を作成したり、異なるSchema 間の関係を管理したりすることができます。

ご案内：

Schemaは互いに参照できます。

Schemaへの参照

下記のスクリーンショットで示すように、API 設計のResponseのBodyパラメータ(JSON/XML 形式)の下でデータタイプを参照モデルにすると、既存のSchemaを選択できます。

1. 選択したSchemaは要件を満たさない場合、Schemaタブでそれを直接に編集できます。

2. Schemaの一部だけを参照したい場合、直接に変更できます。元のSchemaに影響を出しません。

   • Schema 中のいずれかのフィールドを必要としない場合は、フィールドを非表示することができます。そうすると、当該フィールドはAPIドキュメントで表示されなくなります。
   • 特定のユースケースのため、Schemaのいずれかのフィールドを変更する必要がある場合、当該フィールドの参照を解除できます。変更後、いつでも参照を元に戻すことができます。

3. 複数のSchemaを参照できます。さらに、ドラッグ＆ドロップ操作でSchema全体の順番を変えることができます。

プレビュー

データ構造に基づく現実的なデータ生成をサポートします。Mockで結果を簡単に照会することができます。

コード生成

データ構造に基づいて、複数の言語のコード生成をサポートします。コード生成の詳細に関するドキュメントを見る。

ソースコードの編集

Apidogのデータ構造とSchemaは、JSON Schemaの仕様に従うので、JSON Schemaを編集することで、直接にデータ構造を定義できます。JSON Schemaの詳細に関するドキュメントを読む。