アプリケーション開発

Cloud Code プラグインによる API 管理で迅速な API 開発を実現

2024年7月22日

https://storage.googleapis.com/gweb-cloudblog-publish/images/1_jHrBQje.max-2500x2500.jpg

Emanuel Burgess

Developer Advocate, Google

※この投稿は米国時間 2024 年 7 月 11 日に、Google Cloud blog に投稿されたものの抄訳です。

API の配信において中心的な役割を担うデベロッパーは、プロセスの迅速化や簡易化を可能にするツールを求めています。強力な API 管理プラットフォームである Apigee は、API 開発の簡素化と時間短縮を可能にするツールを備え、企業による API のビルド、管理、収益化、スケーリングを支援します。

Apigee は Google Cloud コンソールからアクセスできるほか、一般的に使用される IDE から Cloud Code プラグインを介してアクセスすることも可能です。VSCode の Cloud Code プラグインを使うことで、ワークスペースの作成やプロキシのビルドに加え、Gemini Code Assist の利用が可能になります。これにより、効率的な API 配信を実現できます。プラグインに関する理解を深めるため、まずはワークスペースについて詳しく見ていきましょう。

組織のワークスペース

Apigee におけるワークスペースは、API 開発を支援するために自動的に作成されるフォルダのコレクションを指します。ワークスペースには API 開発に必要なすべてのツールが構造化された形で格納されているため、デベロッパーは必要なツールを準備するための時間を節約することができます。ワークスペースの構成は以下のとおりです。

API プロキシ: プロキシは、プロキシエンドポイント（API の URL）とターゲットエンドポイント（バックエンドサービスへの接続ポイント）で構成されています。プロキシは、API をバックエンドから切り離す役目を果たします。また、ポリシーを使用することで、プロキシの機能を拡張し、管理機能を強化することも可能です。ポリシーは、プロキシを介してメッセージフロー内のさまざまなポイントに追加できます。
共有フロー: 共有フローを使えば、ポリシーやリソースといったよく利用する機能を組織内の複数の API で再利用できます。
環境: 環境は、API プロキシの作成、テスト、デプロイに使用する専用のスペースです。
テストデータ: テストデータは、本番環境に一般的に存在するリソースのセットをひとまとめにしたものです。API プロダクト、デベロッパーアカウント、テスト用のデベロッパーアプリケーション、値など、API の実行に必要なリソースが含まれています。
エミュレータ: エミュレータは、Docker イメージ（ローカルランタイム）を使った単体テストや手動テストによる機能性の検証を行うのに使用します。

Gemini Code Assist を使った API 管理（プレビュー）

https://storage.googleapis.com/gweb-cloudblog-publish/images/2_TeZS3jx.max-1000x1000.png

Gemini Code Assist は、ユーザーが生成 AI を活用して優れたソフトウェアを構築できるよう支援します。ユーザーが自然言語で要件を入力すると、数秒の内に OpenAPI 仕様が作成されます。一連の操作は、すべて Cloud Code プラグインから実行できます。API Hub との緊密なインテグレーションにより、作成された仕様をプラグインから直接登録することが可能です。

Gemini Code Assist を利用するには、まずプロンプトを入力します。プロンプトでは、自然言語を使って API 仕様を記述します。Gemini Code Assist は組織の API Hub にどんなオブジェクトが存在しているかを把握しているため、ビジネス要件に合わせた仕様をプロンプトが入力されてから数秒のうちに返して、コンテキストに基づいた AI による支援を提供できます。こうしたことが可能なのは、組織の API Hub に登録済みの仕様からオブジェクト、メタデータ、セキュリティスキーマを再利用し、API 間での整合性を確保しているためです。

たとえば、発注を行うための API を作成するとします。プロンプトとして、「発注用の API を作成して」という文章を入力します。Gemini は API Hub に登録されているすべての API を確認したうえで、入力されたビジネス要件に合った仕様の案を作成します。Gemini は、レジストリ内にある API からオブジェクトとスキーマを pull して仕様を作成することで、他の API のビジネス要件との整合性を図ります。ユーザーは、求める仕様が出力されるまで、エディタを使ってプロンプトを改良できます。また、同じ画面からプロンプトの履歴を確認することもできます。

モックサーバーによる速度の向上

https://storage.googleapis.com/gweb-cloudblog-publish/original_images/3_MDVKZNg.gif

テストは、API の開発プロセスにおいて重要な位置を占めます。API の開発だけでなく、API のローカル環境や結合テスト環境でのテストも Cloud Code プラグインから行うことができます。API 仕様が作成されると、その仕様とともにローカルのモックサーバーも必ず作成されます。API の操作は、仕様を作成したものと同じ UI から行えます。また、パラメータを修正したり、仮の値を挿入したりすることで、よくあるシナリオやユースケースをシミュレートできます。モックサーバーが自動で作成されるため、API プロキシの機能性をより迅速に検証できるようになります。

さらに、シンプルなワークフローを実行することで、モックサーバーを簡単に Google Cloud プロジェクトにデプロイできます。クラウドにモックサーバーをデプロイすれば、チームの他のメンバーとモックサーバーを共有して、フィードバックを収集するプロセスを短縮することができます。たとえば、サービスのデベロッパーがフロントエンド側の担当者とモックサーバーを共有すれば、デベロッパーが API を実装するためのコードを書かなくても、フロントエンド側の担当者がそのサービスを試してみることが可能になります。