メイン コンテンツをスキップする 補完的コンテンツへスキップ

データ型の作成

データ型とはネットワーク上で交換されるデータを記述したものです。APIバージョン全体で再利用できます。

手順

  1. 左パネルの右上の+ボタンをクリックします。
    情報メモヒント: 前に作成したセクションでデータ型を直接作成するには、セクション名の右側の+ボタンをクリックします。
  2. [Data type] (データ型)をクリックします。
  3. データ型の[Name] (名前)を入力し、[Contact] (連絡先) など、必要に応じて[Description] (説明)を入力します。
  4. オプション: データ型を含める[Section] (セクション)を選択します。
  5. データ型の既存のJSONのサンプルがある場合は、[Generate from JSON example] (JSONサンプルから生成)をクリックしてプロパティを生成するために使用できます。
  6. サンプルを入力し、[Generate] (生成)をクリックします。

    JSONの例を使ってContactデータ型を生成したスクリーンショット。
    このサンプルのすべてのプロパティは、データ型で作成されます。
  7. プロパティを手動で追加するには、[Type] (タイプ)を選択します。
    タイプはデフォルトでobjectになっています。クリックすると、利用できるタイプがすべて表示されます。
    利用できる他のタイプのリストが展開されているobject型のスクリーンショット。
  8. [Add property] (プロパティを追加)をクリックして新しいプロパティを作成し、[Name] (名前)[Type] (タイプ)を定義します。
  9. オプション: プロパティが必要な場合は、[Required] (必須)ボタンを[Yes] (はい)に切り替えます。
  10. 必要に応じて[Description] (説明)を追加し、[more attributes] (その他の属性)をクリックしてデータ型に詳細情報を追加します。

    firstNameプロパティの定義方法の例。このプロパティはString型の必須プロパティで、"Customer's first name"と説明されます。
  11. 必要な数だけプロパティを追加し、[Save] (保存)をクリックします。

このページは役に立ちましたか?

このページまたはコンテンツにタイポ、ステップの省略、技術的エラーなどの問題が見つかった場合はお知らせください。