パスの操作の定義

オンラインで編集する

パスでの操作は、そのパスを使用して API が呼び出されたときに、その API と対話するために使用できるメカニズムを定義します。 事前定義のさまざまなタイプの操作を使用でき、例えば、POST 操作は新しいリソースの作成に最も一般的に使用され、GET 操作はリソースの取得に使用されます。

このタスクについて

注: このタスクは、 OpenAPI 2.0 API 定義の構成に関連しています。 OpenAPI 3.0 API 定義の構成方法について詳しくは、 OpenAPI 3.0 API 定義の編集を参照してください。

このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。

「ソース 」アイコン OpenAPI ソース・アイコンをクリックすると、いつでも直接、基盤となる OpenAPI のYAMLソースに切り替えることができます。 デザインフォームに戻るには、 フォームアイコンをクリックしてください フォーム・アイコン。

手順

  1. OpenAPI 2.0 API 定義の編集の説明に従って、編集のために API を開きます。
  2. 「パス」を展開し、必要なパスを展開します。
  3. ナビゲーションペインの「パス」の下にある 「操作」 の横にある OpenAPI 2.0 API 追加アイコン 追加アイコンをクリックします。
  4. 以下の情報を指定します。
    • Verb: 以下のオプションから操作タイプを選択します。
      1. get
      2. 通知
      3. put
      4. 削除
      5. オプション
      6. ヘッド
      7. パッチ
      8. トレース
    • 要約: 操作の実行内容の要約。
    • 説明: 操作の振る舞いの説明。
    • 操作: 操作を識別するために使用される固有のストリング。 この ID は、API で記述されているすべての操作間で固有でなければなりません。
    • 非推奨: この操作を非推奨にすることを宣言します。 コンシューマーは、宣言された操作の使用を控える必要があります。
  5. 「作成」 をクリックします。
  6. 完了したら、 「保存」 をクリックします。