はじめに
IBMが提供するAPI管理ソリューションというとAPI Connectですが、IBM CloudではそのAPI Connectに加え、よりシンプルに簡単にAPI公開ができるAPI Gatewayというサービスも提供されています。Legagyと付いたものと、無印のAPI Gatewayの２種類があるようです。Qiitaではまだ記事が見当たらないようなので、簡単に試す手順をまとめてみました。
前提
- IBM Cloud Liteアカウント（PAYGなど別アカウントがあればもちろんそれで可）
- FunctionsでHello WorldのサンプルがActionsとしてデプロイ済み
- リクエスト・ボディにJSONで{"name": "xxx"}と入れると、その名前が入ったHello xxxが返り、ボディがないとHello Worldが返るサンプルです。
- リクエスト・ボディにJSONで{"name": "xxx"}と入れると、その名前が入ったHello xxxが返り、ボディがないとHello Worldが返るサンプルです。
手順
-
API Gatewayサービスをまずデプロイします。
-
以下から「Create service」をクリックし、サービス名とリソースグループを指定して作成します。
-
以下から「Create service」をクリックし、サービス名とリソースグループを指定して作成します。
Create an API using Cloud Functionsをクリックし、Create APIから呼び出すAPI定義を作成します。これによりLegacy API Gatewayが自動で作成されます。
-
APIの設定を行います。
- API名と基本パスを設定します。
- API名と基本パスを設定します。
パスとメソッドと既にデプロイ済みのFunctionsのアクションを選択します。GETとPOSTメソッドそれぞれにパスを設定します。
セキュリティを設定します。ここではAPIキーを必須とします。またAPIキーを送信するための方法としてヘッダーを指定します。デフォルトでは悪名高い？X-IBM-Client-IDで、API Connect (V5ベース）だと変更できないのですが、このAPI Gatewayでは変更が可能になっているところがポイントが大きいです。
Rate Limitを設定します。ここでは1分に10回を超える呼び出しをするとエラーになるようにします。
OAuthやCORSの設定はデフォルトのままにします。
リージョン、CF組織、スペースを選択して保存します。
定義が完成し、エンドポイントができたことを確認します
APIキーを作成します。Manage Sharing and API Keysから、Create API Keyをクリックし、キー名を入れて生成したらAPIキーの値をコピーしておきます。
４. Review and Testの各パスのTry itタブから、Client IDにAPIキーを入れて、POSTとGETをそれぞれ呼び出します。GETの場合、200とともにFunctionsのサンプルで設定されているHello Worldが応答として返ります。POSTの場合、ボディに{"name": "Andy"}を入れてリクエストすると、Hello Andyが応答として返ることがわかります。
５. Postmanから呼び出しても同様になることがわかります。
６. Rate Limitを超えると以下のように429エラーを返します。
７. X-Client-IDヘッダーによるAPIキーをつけないと401エラーを返します。
まとめ
以上で簡単にIBM CloudのシンプルなAPI Gatewayサービスで簡単にサンプルAPIを公開する手順をまとめました。次回はLegacyではないAPI Gatewayを試そうと思います。