More than 5 years have passed since last update.

Apigeeで基本的なAPI Proxyを作ってみた

Last updated at 2018-10-01Posted at 2018-09-30

Apigeeとは？

Apigee Corp.は2004年にシリコンバレーで設立された企業であり、API管理プラットフォームの開発・提供をしています。設立当初はSonoa Systemsという企業名でしたが、2010年に社名を現在のApigee Corp.に変更しました。2016年10月にはGoogleに買収され、現在はGoogle Cloudのサービスの1つに取り込まれています。

今回は、API管理プラットフォームであるApigee Edgeの学習を兼ねて簡単なAPI Proxyを作成してみます。

Apigee Edgeの無料アカウントの作成

Apigeeアカウントの料金体系やサービスの差異の概要は下表の通り。

アカウントタイプ	Evaluation	Team	Business	Enterprise
ユーザ数	1ユーザ、1環境	3ユーザ、2環境	5ユーザ、3環境	10 Organization/環境
APIコール数/月	10万件	1500万件	3億件	100億件
統計レポート	30日	60日	90日	12ヶ月
ランタイムSLA	なし	99.5%	99.9%	最大99.99％
値段(月)	無料	$500	$2500	問い合わせ確認
値段(年)	無料	$1500	$25000	問い合わせ確認

目的はApigee Edgeの基本を学ぶことなので、無料の評価用アカウントを作ります。
まずは、Apigeeにアクセスし、右上の「FREE TRAIAL」を選択し、新規ユーザ登録画面を表示させ必要事項を記入します。

ちなみにCopmanyは任意なので特に記入する必要はないです。
その後、入力したメールアドレスにアクティベイト用のメールが届くので、メールに記載されているリンクを開くとアカウント登録は完了です。

各画面について

Apigee Edgeにログインすると、下のような画面が表示されます。

各サイドメニューとサブメニューは以下のとおりです。

Develop

Specs：Swagger Editorを利用してAPIの仕様設計ができます
API Proxies：API Proxyの作成ができます
Shared Flow：トークン認証など複数のAPIで共通するポリシーをShared Flowとして設定することができます
Offline Trace：保存したAPIに対するリクエストからレスポンスまでのトレースができます
API Baas：Apigee Bassへのリンク

Publish

Developers：開発者の追加削除ができます
Apps：開発者とAPIを紐づけ、認証情報などの設定が可能です
API Produces：複数のAppをAPI Productとしてまとめることができます
Portals：開発者向けのポータルページが作成できます

Analyze

API Proxy Performance：API Proxyのトラフィックやレスポンスタイムなどの性能情報の確認ができます
Cache Performance：Apigee Edgeのキャッシュ情報を確認できます
Developer Engagement：どの開発者から最もAPIが呼び出されているのかを確認できます
Devices：どういったデバイス、プラットフォーム、OSからAPIリクエストが投げられているのかを円グラフで確認できます
Error Code Analysis：発生したエラーの割合などエラー解析に必要な情報が確認できます
Geomap：どの国からAPIリクエストが投げられているのかを地図上に表示してくれます
Reports：APIに関するレポート情報をカスタマイズして表示させることができます
Target Performance：Target APIへのトラッフィクやレスポンスタイムなどの性能情報が確認できます
Traffic Composition：開発者やアプリ、APIプロダクトごとのトラッフィク量を比較ができます

Admin

Users：Organizationへのユーザ登録・管理ができます
Roles：Organizationへのカスタムロールの追加やユーザへのロール割り当て状況が一覧で確認できます
Virtual Hosts：バーチャルホストの情報確認・設定ができます。また有償アカウントの場合は、ホストの追加も可能です
Environments：デプロイ環境の詳細設定ができます
Audit Logs：APIのデプロイ履歴、App/API Productのアップデート履歴などを確認できます
Privacy & Security：General Data Protection Regulation(EU一般データ保護規則) の対象となる場合に、「Data Protection Officer」や「EU Representative」を設定することができます。また、ApigeeサポートチームにAPIのトレースツールの利用許可を与えることができます

Learn

Community：コミュニティサイトへのリンク
Docs：公式ドキュメントへのリンク
Support：サポートポータルサイトへのリンク

Send FeedBack：フィードバックを送信できます

本題：API Proxyを作ってみる

というわけで実際にAPI Proxyを作ってみます。作るにはターゲットとなるAPIが必要なので、NHKが提供する番組表APIを利用することにします。
NHK番組表APIの詳細な仕様はNHKの番組表API公式ページに記載されているため割愛、詳細が知りたい方はこちらへ。
今回は「 http://api.nhk.or.jp/v2/pg/list/130/g1/2018-09-16.json?key=払い出したAPIキー」のをターゲットとしたリバースプロキシを作成し、いくつかの機能を後付けで追加していきたいと思います。

その1 : API Proxyの作成

まず初めに、サイドメニュー「Develop」から「API Proxy」を選択し、右上の「+ Proxy」ボタンを押します。
すると、API Proxy作成画面が表示されるので、画面の「Reverse proxy」を選択して「Next」ボタンを押し、詳細入力画面に遷移します。

詳細入力画面ではプロキシ名、APIのURLなど必要事項を入力し、「NEXT」ボタンを押しセキュリティ設定画面に進みます。

セキュリティ設定画面では、認証やCORS設定などを行いますが、これらの設定はあとからでも追加できるので今回は「Pass through」(設定なし)とします。

次に、API Proxyをデプロイした際にバインドされるバーチャルホストを指定します。特にバーチャルホストを指定する必要はないので、default、secureの両方にチェックを入れた状態で「NEXT」ボタンを押します。

最後に、API Proxyのビルド&デプロイします。デプロイ環境はprocとtestを選択できますが、今回はtest環境にのみチェックを入れ、「Build and Deploy」を実行します。

ビルド&デプロイ成功です。

最後にデプロイしたAPI ProxyのURLをRestClientで実行させてみます。URLは「Develop」->「API Proxies」->「NHK-Program-Proxy」を開くと確認できます。下図が実行結果になりますが、NHKの番組情報がリスト形式で取得できることが確認できました。どうやら2018/09/18に大相撲秋場所があるみたいですね。

というわけで、結構さっくりとAPI Proxyを作ることができました。

その2 : JSON to XML 変換機能の追加

NHKの番組表APIはJSON形式のみ対応していますが、アプリによってはXML形式のほうが嬉しい場合もあるかと思います。そんな時は「JSON to XML変換機能」を利用するだけで、簡単にApigee側でXML形式に変換してくれます(同様にXML to JSON変換も可能)。その2ではその1で作成したAPI Proxyに対して「JSON to XML 変換機能」の追加を行ってみます。

まずはじめに「Develop」->「API Proxies」->「NHK-Program-Proxy」を選択してNHK-Program-ProxyのOverviewを表示させます。
OverViewにはAPI Proxyの概要が表示され、右端の「DEVELOP」タブを選択することでAPI Proxyの細かな設定が行えます。

DEVELOP画面では下図のような画面となっており、API Proxyに対して細かな設定や機能追加等がGUIから行えます。
細かな用語説明は別の方がApigee Edgeの用語解説とポリシー機能一覧で解説されているのでそちらを読んでください。
今回はNHK番組表APIのレスポンス結果を加工するので「Target Endpoints」の「PreFlow」を選択し下図の赤い枠で囲まれた「+Step」ボタンを押します。

「+Step」ボタンを押すとポリシー追加画面が表示されます。
今回は「JSON to XML 変換機能」の追加が目的なので、「JSON to XML」を選択します。

追加すると、Flow画面に追加された機能がアイコンとして表示されます。
また、Code画面の「Preflow」のResponseにJSON-to-XMLも自動で追加されます。

機能追加ができたのでAPI Proxyを保存します。
保存する際は「Project」->「Save as New Revision」を選択すると、新しいリビジョンとしてAPI Proxyが保存されます。
また、確認ダイヤログが表示されるので[OK]ボタンを押します。

API Proxyを保存すると画面上部の数字(リビジョン番号)が1から2に変更されます。
次に「Deployment」->「test」で保存したリビジョンをtest環境にデプロイします。

その1同様にRestClientで実行させてみたところ、レスポンス結果JSONからXMLに変わったので「JSON to XML 変換機能」の追加は成功です。

その3 : API Keyによるアクセス制御の追加

基本的にAPIにはそのAPIの利用者やアプリを制限するための暗号鍵をAPIのパラメータやHeaderに埋め込んで渡すのが一般的です。
そのため、その2で作成したAPI Proxyの利用者を制限するために、APIキーを設定します。

その3-1 : ポリシーの追加

こちらの公式サンプルを参考にして進めていきます。
サンプルによると必要となるのはAPI Keyの検証を行う「Verify API Keyポリシー」と検証後に受け取ったAPI Keyをリクエストフローから削除する「Assign Messageポリシー」の2つなので、これらの機能をその2と同じ要領で追加していきます。
まずは、DEVELOP画面を開き「PreFlow」->「+Step(右上)」を選択し、「Verify API Keyポリシー」「Assigen Messageポリシー」を追加します。

追加後は下図のように表示されます。
(「Assigen Messageポリシー」の名前はわかりやすいように「Remove Query Param」としています。)

次に追加した「Remove Query Param」を下記の通り修正します。
XMLは「Navigator」->「Policies」->「Remove Query Param」を選択すると表示されます。

Remove-Query-Param.xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage name="Remove-Query-Param">
    <DisplayName>Remove Query Param</DisplayName>
    <Remove>
        <QueryParams>
            <QueryParam name="apikey"/>
        </QueryParams>
    </Remove>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"></AssignTo>
</AssignMessage>

あとはその2同様に、新しいリビジョンとして保存します。

その3-2 : APIキーの発行

ポリシー追加により、APIキーがないと番組表を取得することができなくなりました。
なので、作成したAPI Proxyに対応するAPIキーを発行します。

まずは開発者を登録します。
「Publish」->「Developers」->「+Developer」を選択し、テスト用の開発者を追加します。

次に、「Publish」->「API Products」->「+API Product」を選択し、API Productを作成します。
API ProductのResourcesには作成したAPI ProxyのNHK-Program-Proxyとリビジョンを指定します。

「Publish」->「Apps」->「+App」を選択し、登録したユーザとAPI Productを紐づけたDeveloper Appとして登録します。
Developerに先ほど作成したTestUserを、CredentialsにNHK-API-Productを設定して保存します。

これでCredentialsのConsumer KeyにAPIキーが登録されたので、API Proxyを実行する際に「?apikey=登録されたAPI Key」をつけてやれば番組表が取得できます。

実行結果です。
まずはその1、その2同様にAPI Keyなしで実行してみたところ、「Verfy API Keyポリシー」で「！」マークがついており、レスポンス結果も401となっていることから認証エラーとなっていることがわかります。

次にAPIキーありの実行結果です。
HTTPステータスが200となっており正常に動作しています。

その他参考情報

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up