このチュートリアルでは、既存のサービスへのプロキシーとして機能する REST API 定義を定義して実装する方法について説明します。
開始前に
注 ：Sandboxカタログは、
DataPower® API Gateway 、
DataPower Gateway (v5 compatible) 、またはその両方を使用するように設定する必要があります。 詳細については、
カタログの作成と構成を参照してください。
REST API 定義の作成
架空の銀行の支店の詳細情報を返すREST APIを作成し、定義することができます。
BankA 以下の手順に従ってください。
- API Manager にログインします。
- ホーム・ページの左側のパネルで、「 開発」 アイコンをクリックするか、下図のように「 APIと製品の開発」 タイルをクリックする。
- 「開発 」画面で、 」をクリックします。
- 画面で OpenAPI 2.0 画面で OpenAPI 2.0 タブを選択します。
注： デフォルトでは OpenAPI 2.0 タブが選択されています。
- Create］ セクションで、［ From target service ］ラジオボタンを選択します。
- 次へ をクリックします。
- Create API from target service（ターゲットサービスからAPIを作成 ）］画面の［ Info（情報） ］セクションで、以下の値を入力してターゲットサービスからREST APIを作成します。
- タイトルフィールドに「 Branches 」と入力します。
注： 「 名前」 フィールドには、 「タイトル」 フィールドに入力した値が自動的に入力されます。 この場合、 「名前」 フィールドには branches が自動入力される。
- バージョンフィールドは 1.0.0 のままにしておいてください。
「基本パス」フィールドには「/branches」が自動的に入力されます。
- 対象サービス URL フィールドに https://sample-api.us-east-a.apiconnect.automation.ibm.com/bank/branches
- 次へ をクリックします。
- セキュア」 セクションで
- 「Client ID」 および「 CORS 」のチェックボックスがまだ選択されていない場合は、それらを選択してください。
- 次へ をクリックします。
- サマリー・ セクションの下にある、
- 生成された OpenAPI 2.0 定義と 適用されたセキュリティに緑色のチェックマークがついていることを確認する。
緑色の目盛りは、APIの作成が成功したことを示す。
- 「API の編集」をクリックして、API の構成を続行します。
- 新しい画面で、まだ選択されていなければ、 Design タブを選択します。
- デザイン・ビュー 画面の左パネルで、 Definitions に隣接する + アイコンをクリックします。
- スキーマの追加ダイアログボックスで
- スキーマ名（キー ）フィールドに address と入力します。
- Type ドロップダウンリストから、 object を選択する。
- 追加 をクリックします。
スキーマの追加] ダイアログ・ボックスが閉じました。 デザインビュー 画面の右パネルには、 アドレスセクションが表示されます。
- アドレス・ セクションの 「説明」 フィールドに、「 The format of the address object 」と入力する。
- 右上の「 保存 」をクリックする。
新しいオブジェクト " address "のスキーマが " Definitions " セクションに表示されました。
- 新しいオブジェクトのプロパティを作成するには、 アドレス、
- 定義」 セクションで 「住所 」を選択する。
住所欄は右のパネルに表示される。
- アドレスセクションで、 Addをクリックする。
Add new property ダイアログボックスが表示されます。
- プロパティを設定するには、 新規プロパティの追加ダイアログボックスで以下の値を入力します。
- Name フィールドに street1 と入力する。
- Type 」ドロップダウンリストから、「 string 」を選択する。
- 説明フィールドに、 The first line of the
address を追加する。
- 保存 をクリックします。
新しいスキーマプロパティが作成され、「 に表示されます。
- プロパティの設定を完了するには、次のオプションアイコン （3つの点）をクリックします。 street1 をクリックし、 Details を選択します。
View details for street1ダイアログボックスが表示されます。
- View details for street1ダイアログボックスで、以下の手順を実行します。
- Documentation タブをクリックします。
- 値の例」 フィールドに、 4660 La Jolla Village
Drive と入力する。
- 保存 をクリックします。
- 他の新しいスキーマ・プロパティを作成するには、ステップ14を繰り返し、表1に示す値を入力する。
表 1. アドレスのプロパティ
| スキーマ名 (キー) |
タイプ |
説明 |
サンプルの値 |
| street2 |
string |
The second line of the address |
Suite 300 |
| city |
string |
The city of the address |
San Diego |
| state |
string |
The state of the address |
CA |
| zip_code |
string |
The zip code of the address |
92122 |
注： 開発者はスキーマ定義をコンシューマー・カタログで見つけることができる。 これらのスキーマ定義には、開発者がレスポンスに期待するデータタイプに関する情報が含まれている。
- 2つ目の定義スキーマを作成するには、ステップ11からステップ12を繰り返す。
例えば、 branch という新しい定義スキーマを作成します。
- branch のプロパティを設定するには、ステップ13からステップ14を繰り返し、表2に示す値を入力する。
注： 作成したスキーマ定義の Example値を追加してアクセスするには、 Saveをクリックしてプロセスを完了する必要があります。
表 2. ブランチのプロパティ
| スキーマ名 (キー) |
タイプ |
説明 |
サンプルの値 |
| address |
address |
The address of the branch |
|
| type |
string |
The type of branch |
atm |
| id |
string |
The ID of the branch |
9d72ece0-7e7b-11e5-9038-55f9f9c08c06 |
Address プロパティの場合、 type セクションはAPI内で作成した定義を参照し、 example セクションは空白であることに注意してください。 このプロセスを踏めば、複雑なデータ構造を作ることができる。
- 新しいパスを追加するには、 デザイン・ビュー 画面の左パネルで、 パスに隣接する ＋ アイコンをクリックします。
- スキーマの追加ダイアログ・ボックスで、以下の手順を実行する。
- Path フィールドに /details と入力する。
- 追加 をクリックします。
「/details」という新規パスが使用可能なパスのリストに表示されます。
- で、 [操作] の横にある 「+」 アイコンをクリックします
- スキーマの追加ダイアログ・ボックスで、以下の手順を実行する。
- 動詞のドロップダウンリストから、 getを選択する。
- 追加 をクリックします。
GET セクションはデザイン・ビュー 画面の右パネルに表示される。
- デザインビュー 画面の右パネルにある［ 保存 ］をクリックします。
- パスの GET 操作を編集するには、 /detailsをクリックします。
- パス内の GET 操作を編集するには、 デザインビュー画面の左側のパネルで、 の下にある [GET] をクリックします。
- 右パネルの GET セクションで、 Responses セクションまでスクロールダウンする。
- 応答を編集するには、以下の手順を実行する。
- 200に隣接するオプションアイコン （3つの点）をクリックし、 編集を選択します。
デザイン画面の右パネルに 200というセクションが表示される。
- 200」 セクションで、以下のステップを実行する。
- 名前（キー） フィールドに、 200 と入力する。
- 説明フィールドには、 200 OK と入力する。
- 保存 をクリックします。
APIはオンラインで利用可能になりましたので、テストすることができます。
REST API のテスト
注： クロスオリジンリソース共有（ CORS ）の制限により、 macOS Catalinaプラットフォーム上のChromeまたはSafariブラウザでは、アセンブリテストツールを使用できません。
始めにREST API をテストする前に、ゲートウェイ・サービスを構成する。
REST API をテストするには、以下のステップを実行します。
- Developページで、APIに隣接する Menu アイコン（3つの点）をクリックし、 Edit APIをクリックします。
- [テスト] タブ をクリックします。
- Target Configurationをクリックします。
環境設定ダイアログボックスが表示されます。
- 環境設定ダイアログボックスで、以下のタスクを実行する。
- 自動公開オプションをオンに設定する。
- 目標製品レート制限を設定するには、以下のタスクを実行します。
- 「編集」をクリックします。
- Choose a Rate Limit ダイアログボックスで、 Custom ラジオボタンを選択します。
- 通話回数」 テキストボックスに「 5 」と入力する。
- Per ドロップダウンリストから、" hour " を選択する。
- 「レート制限を選択」 をクリックします。
- 環境設定ダイアログボックスで、 環境設定の保存をクリックします。
- ページ上部の「 開発 」をクリックする。
- Developページで、編集したいAPIの隣にある Menu アイコン（3つの点）をクリックし、 Edit APIをクリックします。
- [テスト] タブ をクリックします。
- 「テスト」ページのバナーで、APIが 「オンライン」 に設定されていることを確認してください。
- APIコールを実行するには、 Request セクションで Sendをクリックする。
これはAPIをテストする。 レスポンスには、定義したステータス・コード（200）と、APIが取得した銀行支店のデータが表示されます。
- 定義されたレート制限を超えるように、 [送信] を少なくとも 5 回クリックします。 これで、レート制限を超過したことを示すステータスコード 429「リクエストが多すぎます」が返されます。
このチュートリアルで実行したこと
このチュートリアルでは、以下のアクティビティーを実行しました。
- REST API の定義を作成しました。
- REST API をテストしました。