チュートリアル: Gemini Code Assist を使用して Apigee と Cloud Code で API を設計、開発、テストする

このページは Apigee と Apigee ハイブリッドに適用されます。

概要

このチュートリアルでは、Cloud Code で Gemini Code Assist を使用して API を設計し、生成された API 仕様から Apigee API プロキシを作成する方法について説明します。このチュートリアルでは、自然言語プロンプトを使用して、ウェブサイトのスポーツ関連のブログ投稿を管理する API を設計して作成します。

始める前に

このチュートリアルを完了するには、次のものが必要です。

  • Apigee プロジェクト用に設定された Cloud AI Companion API または、Apigee 組織の管理者権限を持ち、Cloud AI Companion API を追加できる権限。Gemini Code Assist の設定手順については、Gemini Code Assist を使用するをご覧ください。
  • Apigee プロジェクトの Apigee API 管理者である。
  • まだ設定していない場合は、Cloud Code で Apigee プロジェクトのローカル開発を設定します。VS Code の Cloud Code での Apigee API Management の設定をご覧ください。
  • OpenAPI 仕様に精通している（生成された仕様を確認できる）
  • （省略可）このプロジェクト用に設定された API Hub。ここで説明する Gemini Code Assist 機能の使用は必須ではありませんが、API Hub がないとすべての手順を実行することはできません。

ステップ 1: Cloud Code で Apigee を読み込む

VS Code を開き、Cloud Code アイコンをクリックします。Apigee プロジェクトと API が表示されます。

Cloud Code Gemini Code Assist の左側のメニュー

ステップ 2: [API 仕様の作成] タブを開いてプロンプトを入力する

[Apigee] 行にある魔法の杖アイコンをクリックして、仕様作成タブを開きます。

Cloud Code Gemini Code Assist による仕様の作成の魔法の杖

このタブには、API プロンプトの開始に使用できるテンプレートが表示されます。自由形式のプロンプト入力フィールドが下部に表示されます。[ブログ コンテンツ用 API] をクリックします。この API を説明する自然言語のプロンプトが、プロンプト入力フィールドに入力されます。

Cloud Code Gemini Code Assist の作成仕様フォーム

ステップ 3: 仕様を作成して表示する

[作成] をクリックして、このプロンプトから API 仕様を生成します。仕様の生成を待ちます。仕様が作成されると、[出力] パネルにステップが表示されます。

作成したら、下にスクロールして、仕様の説明、エンドポイント、スキーマを表示します。OpenAPI 仕様コードを表示するには、[コードを表示] をクリックします。

Cloud Code Gemini Code Assist 仕様のエンドポイント

ステップ 4: プロンプトを変更して仕様を再作成する

プロンプトに戻り、データ オブジェクトの一部としてスポーツの種類を追加します。

Cloud Code Gemini Code Assist の編集プロンプト

[作成] をもう一度クリックして、仕様を再生成します。更新された仕様にスポーツの種類が表示されます。

プロンプト入力ボックスの上部にあるプロンプト履歴をクリックすると、前のメッセージに戻ることもできます。

ステップ 5: 仕様を編集する

仕様を変更するには、[コードを表示] をクリックして、仕様内で直接更新内容を入力します。この例では、説明を「Sports Blog Post Content Management API」に変更します。

Cloud Code Gemini Code Assist の編集コード

ステップ 6: モックサーバーを使用して API をテストする

API のレスポンスをエミュレートするローカルモックサーバーを使用して API をテストします。[サーバー] プルダウンで、名前に [ローカル開発サーバー] が含まれるオプションを選択します。選択したら、[POST] パスを開き、[試してみる] をクリックします。

リクエスト本文の値「author」、「content」、「title」を、独自の値を使用するように変更します。

{
    "author": "My name",
    "categories": [
      "string"
    ],
    "content": "This is my blog post",
    "featuredImageUrl": "string",
    "publishedDate": "string",
    "tags": [
      "string"
    ],
    "title": "Baseball in the age of AI"
  }

[実行] をクリックすると、[レスポンス] セクションに API からのモック レスポンスが表示されます。

ステップ 7: API を API Hub に保存する

（省略可）API が審査され、完成したら、API Hub に登録してデベロッパーが使用できるようにします。

  1. [Register to API Hub] をクリックします。
  2. 画面の指示に沿って API を登録します。API Hub への登録と提供する必要がある情報については、API を登録するをご覧ください。

[保存] をクリックして、任意の名前で新しい API を保存します。

ステップ 8: この仕様から API プロキシ バンドルを作成する

この仕様から Apigee API プロキシ バンドルを作成するには、[その他] メニューから [API proxy バンドルの作成] をクリックします。作成後、左側のメニューの [apiproxies] に新しいプロキシが表示されます。Cloud Code での API プロキシの操作方法については、API プロキシの開発をご覧ください。
Cloud Code Gemini Code Assist 作成の API プロキシ バンドル

次のステップ