[Advent Calendar 2017 Day12] API Management 導入編
こちらの記事は、Qiita に掲載した Microsoft Azure Tech Advent Calendar 2017 の企画に基づき、執筆した内容となります。 カレンダーに掲載された記事の一覧は、こちらよりご確認ください。
みなさまこんにちは。Azure サポート チームの片岡です。
本日のブログでは、App Service などの Web 系サービスを利用して公開された Web API 群の前段に配置する API Management というサービスをご紹介します。
App Service などのように主役となるサービスではございませんが、Web API の管理をしやすくするという観点で一役買うサービスであり、二―ズも増えてきております。
すべてを紹介すると長くなってしまうので、今回は導入編として簡単な機能を紹介いたしますが、今後もカスタマイズ機能などについて随時紹介していきます。
また、下記では発行者ポータルでの手順を紹介しておりますが、現在 API Management は Azure ポータルへの移行を進めており、基本的には Azure ポータルでも同様の設定が可能です。
1. API Management とは ?
ひとことで言うと、Web API の Gateway となるサービスです。
近頃の Web サービスでは、ユーザーが実際にアクセスする UI をもった Web ページから、バックエンドのWeb API を呼び出すという作りとなっていることが一般的です。
Web API がひとつのみであれば簡易に管理が可能ですが、複数の Web API を呼び出す、特にドメインが異なる Web API を複数呼び出す場合には、その分管理が煩雑となります。
API Management は以下のような機能を提供し、Web API の管理に一役買います。
- 管理ポータルの提供
- ドメインの統一
- Web API のユーザー管理、アクセス キーの発行
- HTTP ヘッダーなど、HTTP リクエスト/レスポンスのカスタイマイズ
では、早速それぞれの機能を見ていきましょう。
2. 管理ポータルの提供
API Management をデプロイすると、発行者ポータル、および開発者ポータルという 2 つの管理用ポータルが併せてデプロイされます。
発行者ポータルでは Web API のコール数などが確認できるダッシュボードの表示や Web API の登録、ユーザー管理などの機能が提供され、開発者ポータルでは実際の Web API 呼び出しをテストするといった機能が提供されております。
それぞれのポータルは、Azure ポータルから直接アクセスすることが可能です。
3. ドメインの統一
ひとつの Web サービスでは多くの機能が提供されておりますので、その分多くの Web API が呼び出されることがあります。
複数の Web API ですので、ドメインが異なることも一般的ですが、API Management では、すべての Web API を同じドメインに統一し、パスのみで Web API を区別できます。
API の登録は、発行者ポータルから以下のように登録が可能です。
3-1) 発行者ポータルの [APIs] – [ADD API] をクリックします。
3-2) 実際の Web API の URL などを入力します。以下の例では、実際の Web API の URL は https://contoso.azurewebsites.net/ ですが、API Management のドメインである https://apim.ykataoka.com/ に統一する例です。
同じ API Management サービスに登録された API 群はすべて同じドメイン名となり、その後に続くパスで API を区別します。
3-3) 最後に Web API を選択して "Operations" タブをクリックし、"Operation" を登録します。GET リクエストや POST リクエストなどの HTTP メソッド、実際のアクセス パス (下記例は https://contoso.azurewebsites.net/todolist) などの情報を入力し、Web API の登録は完了です。
上記の手順で登録した Web API は、開発者ポータルにて実際に動作を確認することができます。
以下の画像は、API Management を作成した際に既定作成される Echo API のページですが、"Try it" ボタンをクリックすることで動作が確認できます。
4. Web API のユーザー管理、アクセス キーの発行
API Management では、ユーザーおよび Product を登録することでアクセス キーが発行され、登録されたユーザーが Web API を利用することが可能となります。
Product とは、API や、その API に設定しているポリシーなどをまとめた概念であり、各ユーザーは Product をサブスクライブする必要がございます。例えば「○○ の Product のユーザーは 1 分間に最大 5 回までの呼び出しを許可する」、「□□ の Product のユーザーは無制限に呼び出しを許可する」といった制御に利用されます。
各 Web API は、必ずいずれかの Product に登録されている必要があり、その Product のルールに沿った呼び出しが可能です。ユーザーと Product はいずれも発行者ポータルから登録します。
4-1) ユーザー登録
4-2) Product 登録
5. HTTP ヘッダーなど、HTTP リクエスト/レスポンスのカスタイマイズ
HTTP ヘッダーなどのカスタマイズというタイトルとはしましたが、ポリシーという機能であり、HTTP リクエストやレスポンスのカスタマイズ、HTTP レスポンス コードの変更、ログ機能の追加など、ブログでは紹介しきれなほどとにかく様々なカスタマイズが可能となる API Management の中核機能です。
ポリシーは、Azure ポータルや発行者ポータル上で設定可能であり、XML 形式で定義を行います。基本的な設定方法、またよくご利用をいただくアクセス制限ポリシーについては、以下でご紹介をしております。
How to set or edit Azure API Management policies
https://docs.microsoft.com/ja-jp/azure/api-management/set-edit-policies
API Management のアクセス制限ポリシー
https://docs.microsoft.com/ja-jp/azure/api-management/api-management-access-restriction-policies
また、アクセス制限ポリシー以外にも様々な実装が可能であり、例えば HTTP リクエストのヘッダーの内容に応じた処理を行う、HTTP レスポンスのステータス コードをカスタマイズするといった処理も可能です。
それらのポリシーについて、また XML 内で利用できるポリシー式は、以下でご紹介をしております。ポリシー式は、System.DateTime や System.Text など、.NET Framework で利用可能なクラスが利用できたりと、比較的なじみやすい形式の変数が利用可能です。
API Management の高度なポリシー
https://docs.microsoft.com/ja-jp/azure/api-management/api-management-advanced-policies
API Management ポリシー式
https://docs.microsoft.com/ja-jp/azure/api-management/api-management-policy-expressions
なお、ポリシーは、<inbound>/<backend>/<outbound>/<on-error> の 4 つのタグから構成され、制御したい内容に応じて、タグ内にポリシーを定義します。(<on-error> は省略可能)
例えば、API Management が受信するクライアントからの HTTP リクエストに関する制御を行いたい場合には <inbound> タグ、バックエンドの API から返された HTTP レスポンスに関する制御を行いたい場合には <outbound> タグに制御内容を定義します。
そして、それぞれの処理の中で何らかのエラー (許可されていない IP アドレスからのアクセスが発生したなど) が発生した場合には、<on-error> タグ内の処理が実行されます。
例といたしまして、IP アドレスによるアクセス制限を行い、許可されていない IP アドレスからのアクセスに対しては HTTP 599 エラーを返すポリシー式は以下の通りとなります。
~~~~~
<policies>
<inbound>
<ip-filter action="allow">
<address>IP アドレス</address>
</ip-filter>
<base />
</inbound>
<on-error>
<return-response>
<set-status code="599" reason="AccessDenied" />
<set-body>Unallowed IP address.</set-body>
</return-response>
</on-error>
</policies>
~~~~~
※ <backend> および <outbound> は割愛しております。
その他にも様々なカスタマイズが可能なので、ぜひ Web API の利用にご利用いただけますと幸いです！