データ型とはネットワーク上で交換されるデータを記述したものです。APIバージョン全体で再利用できます。
手順
-
左パネルの右上の+ボタンをクリックします。
ヒント: 前に作成したセクションでデータ型を直接作成するには、セクション名の右側の+ボタンをクリックします。
-
[Data type] (データ型)をクリックします。
-
データ型の[Name] (名前)を入力し、[Contact] (連絡先) など、必要に応じて[Description] (説明)を入力します。
- オプション:
データ型を含める[Section] (セクション)を選択します。
-
データ型の既存のJSONのサンプルがある場合は、[Generate from JSON example] (JSONサンプルから生成)をクリックしてプロパティを生成するために使用できます。
-
サンプルを入力し、[Generate] (生成)をクリックします。
例
このサンプルのすべてのプロパティは、データ型で作成されます。
-
プロパティを手動で追加するには、[Type] (タイプ)を選択します。
タイプはデフォルトで
objectになっています。クリックすると、利用できるタイプがすべて表示されます。
-
[Add property] (プロパティを追加)をクリックして新しいプロパティを作成し、[Name] (名前)と[Type] (タイプ)を定義します。
- オプション:
プロパティが必要な場合は、[Required] (必須)ボタンを[Yes] (はい)に切り替えます。
-
必要に応じて[Description] (説明)を追加し、[more attributes] (その他の属性)をクリックしてデータ型に詳細情報を追加します。
例
-
必要な数だけプロパティを追加し、[Save] (保存)をクリックします。
このサンプルのすべてのプロパティは、データ型で作成されます。
