Contents
Apigee Edge環境でのAPIプロキシ構成の実務的ステップバイステップガイド
Apigee Edgeは、APIゲートウェイとしての機能と高度なマネジメント能力を備えたクラウドサービスで、企業がAPIを安全かつ効率的に公開するための基盤となっています。特にAPIプロキシ設定方法については、UI操作やCLIコマンドを組み合わせた柔軟なアプローチが求められます。本記事では、最新のApigee Edge環境において、APIプロキシを作成・構成・テストする実務的ステップバイステップガイドを解説します。導入からデプロイまでの一連のフローを視覚的に整理し、実践的な手順を明確化します。
Edge UIによるプロキシ作成フロー
Edge UIは直感的な操作性が特徴で、初学者でも簡単にAPIプロキシの基本設定が可能です。ただし、DevOpsエンジニアのように高頻度での構成変更が必要なケースでは、CLIとの連携が重要です。
アカウント認証と環境選択
Apigee Edgeにログインし、Organization(組織)とEnvironment(環境)を選択します。
- Organization: GCPアカウントで作成したプロジェクトを指定
- Environment: 「Dev」「Test」「Prod」など目的ごとに分離可能
注意点: 環境ごとの設定変更は、Edge UIの「Settings > Environments」から確認・編集が可能です。
プロキシテンプレートの選定と初期設定
- Edge UI左メニューの「API Proxies」を開く
- 「+ Proxy」ボタンをクリックし、テンプレート(例えば
Basic Proxy)を選択 - API名やベースパスを入力後、「Create」を押下
Cloud Code連携ポイント: テンプレート作成後に「Download」から構成バンドルを取得し、ローカルで編集→アップロードが可能になります。このステップは後のCLI手順と直結します。
Cloud Code経由の構成バンドルアップロード手順
Cloud CodeはApigee Edgeとの統合開発を効率化するツールで、特にDevOpsエンジニア向けにCLI操作がサポートされています。以下は具体的な手順です。
プロジェクト構成ファイルの作成
apiproxyフォルダを作成し、以下のファイルを配置:proxy.xml(プロキシ設定)targetserver.xml(バックエンドサーバー情報)-
policy.json(認証ポリシー例) -
apigee.yamlを作成し、Edge UIとの連携情報を記載:
yaml
apigee:
org: your-org-name
env: test
Edge UIとCloud Codeの連携設定
- CLIでApigee CLIをインストール:
npm install -g @apigee/apigee-cli apigeetool loginを実行し、GCPアカウント認証を完了- ローカルの構成ファイルをバンドル化:
apigeetool bundle .
バンドル生成とデプロイ
- 作成したバンドル(
.zip)をEdge UIでアップロード - 「Deploy」ボタンから環境に適用
- CLIで状態確認:
apigeecli proxy get -n your-proxy-name -e test
事前準備として必要なアカウント設定項目
APIプロキシ構成の前に、以下のチェックリストを実施することでトラブルを回避できます。
Organization/Environmentの設定チェックリスト
| 項目 | 値 | 補足 |
|---|---|---|
| Organization | your-org-name |
GCPアカウントに紐づく必須項目 |
| Environment | test, prod |
開発・本番環境分離が推奨 |
APIプロキシの権限設定
- プロキシ作成・編集は「Apigee Admin」ロールが必要
- 事前にGCP IAMでユーザーに権限を付与
OAuthクライアントIDの取得
- GCP Console → APIとサービス → 処理 からOAuthクライアントを作成
- クライアントIDをEdge UIの「Security > OAuth」セクションへ入力
デプロイ後のテスト方法とトラブルシューティング
PostmanでのAPI呼び出し例
以下は、構成したプロキシに対してPOSTリクエストを送る例です:
|
1 2 3 4 5 6 7 |
POST https://your-proxy-name-test.apigee.net/api/resource Content-Type: application/json { "key": "value" } |
Edge UIの監視機能活用
Edge UI → 「API Proxies」 → 選択したプロキシ → 「Analytics」タブで、リクエスト数やエラーレートを可視化できます。
ログ解析によるエラーコード対応
- Edge UIの「Logs」セクションから、リクエストIDをもとに詳細ログを検索
- エラー発生時のコード例(例:
403 Forbidden)に対し、認証ポリシーを再確認
CTA: 本記事で紹介したサンプルコードを使用して、Apigee Edge環境で実際に検証し、ご意見や課題をお寄せください!
今後の展開とコミュニティへのご意見募集
Apigee Edgeの最新機能動向
2024年現在、Apigee EdgeではAI駆動型のパフォーマンス最適化機能や自動監視設定が導入され始めています。こうした機能は将来的にプロキシ構成をさらに効率化する可能性があります。
コメント欄での実装経験共有のお願い
本記事の内容について、以下の点でご意見やご質問があれば、ぜひコメント欄へお寄せください:
- CLIによるバンドルアップロードの課題
- Edge UIとCloud Codeの連携ポイントの改善案
- 実際のデプロイ時のエラーメッセージ事例