REST API のパスの定義

パスとは、呼び出し可能な単位の REST API を指します。パスは、HTTP 動詞と、公開時に API の基本パスと結合される URL パスから成ります。パスを構成することで、開発者への API の公開方法を定義します。

パスを定義するには、以下のステップを実行します。

1. 前に UI ナビゲーション・ペインをピン留めしていなかった場合は、「ナビゲート先」アイコン をクリックします。 API Designer UI ナビゲーション・ペインが開きます。UI ナビゲーション・ペインをピン留めするには、「メニューのピン留め」アイコン をクリックします。
2. UI ナビゲーション・ペインの「ドラフト」をクリックし、「API」をクリックします。 「API」タブが開きます。
3. 「API」をクリックします。 「API」タブが開きます。
4. 作業する REST API 定義をクリックします。
5. 「パス」セクションで、「パスの追加」アイコン をクリックします。 パスが追加されます。
6. 「パス」フィールドに、パス・セグメントを追加します。
   注: フル API (それを含む API の基本パスの後にここで定義するパス・セグメントを続けたものから作成) は、IBM® API Connect システム内のすべてのパス内で固有でなくてもかまいません。ただし、URL が固有でない場合は、アプリケーションが、操作の呼び出し時にクライアント ID で自身を識別する必要があることを指定しなければなりません。このクライアント ID を使用することで、そのアプリケーションがサブスクライブしているプランに応じて、呼び出し対象の操作が一意に判別されます。

   アプリケーションの識別要件の指定について詳しくは、API キー・セキュリティー定義の作成を参照してください。

7. デフォルトでは、GET HTTP 操作が使用されます。操作を削除するには、その操作の右側にある「操作の削除」アイコン をクリックします。
8. 別の操作タイプを追加するには、「操作の追加」をクリックします。操作で提供する機能に応じて、以下のいずれかの HTTP 操作を選択します。

   • GET

     データをサーバーから取得します。

   • PUT

     サーバーに保存されているデータを更新します。

   • POST

     処理のためにサーバーにデータを送信します。

   • DELETE

     データをサーバーから削除します。

   • PATCH

     パスに部分修正を適用します。PATCH メソッドは、PUT メソッドとは異なり、操作全体を置き換えるのではなく、増分変更を適用します。

     注: PATCH 操作を使用する場合は、IBM API Connect ゲートウェイで DataPower® ファームウェア・バージョン 7.0.0 以降が実行されている必要があります。これが実行されていない場合は、ゲートウェイによって要求が拒否されます。

   • HEAD

     GET メソッド呼び出しと同じ応答を要求しますが、応答本文は要求しません。このメソッドは、コンテンツ全体を転送することなく、応答ヘッダーに書き込まれた情報を取得するときに役立ちます。

   • OPTIONS

     リソースのアクションを暗黙的に指定したり、操作の取得を開始したりすることなく、HTTP メソッドと、Web サーバーまたは操作でサポートされる他のオプションを取得します。

   注: それぞれのパスに対して、操作は 1 つだけ指定できます。
9. オプション: パスおよびそのすべての操作に対して含める必要のある任意のパラメーターを追加します。
   1. 「パス」セクションで「パラメーターの追加」をクリックします。
   2. 「名前」フィールドに、パラメーターの名前を入力します。
      注: appId、client_id、client_secret、および appSecret の各照会パラメーターは予約されていて、使用できません。
   3. 「場所」フィールドで、操作の呼び出し内でこのパラメーターが見つかる場所を選択します。
   4. オプション: 前のステップで「パス」を選択した場合は、「パス」フィールドのパラメーターの場所を以下の形式で定義する必要があります。

      /Path_Segment_1/{Parameter}/Path_Segment_2

      ここで、
      • Path_Segment 変数は、パス・セグメントの名前です。
      • Parameter は、パラメーターの名前です。この名前は、ステップ 9.b でそれを定義するために使用した名前と一致する必要があります。
   5. オプション: 「説明」フィールドに、パラメーターの説明を入力します。
   6. 「必須」チェック・ボックスを使用して、呼び出しが有効であるためにそのパラメーターが必須かどうかを指定します。
   7. オプション: 「タイプ」のドロップダウン・リストから、API Connect によって呼び出しが受信される際の、パラメーターの予期されるデータ型を選択します。「場所」に「本文」を設定した場合、API に定義した JSON スキーマを選択できます。JSON スキーマの作成について詳しくは、REST API の作成のステップ 24 を参照してください。
10. 操作を構成します。詳しくは、操作の構成を参照してください。操作タイプに応じて、操作ごとにプロパティーまたは応答を少なくとも 1 つ入力する必要があります。
11. 「保存」アイコン をクリックして、変更を保存します。