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

このページの内容は Apigee と Apigee ハイブリッドに該当します。

概要

このチュートリアルでは、Gemini Code Assist の @Apigee ツールを使用して API 仕様を作成、編集するプロセスについて説明します。歯科医院の予約を管理する API を設計して作成するために、自然言語プロンプトを使用します。仕様が準備できたら、テストして Apigee API プロキシを作成することもできます。

Gemini Code Assist を使用した API 仕様の作成と編集の詳細については、API の設計と編集をご覧ください。

始める前に

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

ステップ 1: Gemini Code Assist チャットを開く

VS Code を開き、Gemini Code Assist のチャット アイコンをクリックします。チャット ウィンドウが表示されます。

Cloud Code の Gemini Code Assist チャット

ステップ 2: Apigee ハンドルを入力して Apigee ツールを使用する

チャット ウィンドウに「@Apigee」と入力します。Apigee プロンプトのリストが表示されます。[Create an API specification] を選択します。

Apigee ツールを含む Cloud Code の Gemini Code Assist のチャット ウィンドウ

ステップ 3: プロンプトを入力する

入力フィールドに次の説明を入力して送信し、プロンプトを完了します。

@Apigee Create an API specification for patients to schedule their own appointments with a dental office. Include multiple dentists and a dental appointment type, which can be regular checkup or other.

作成プロンプトを含む Cloud Code の Gemini Code Assist のチャット ウィンドウ

ステップ 4: 仕様を表示する

Gemini Code Assist が仕様を生成するまで待ちます。仕様が利用可能になると、API Hub と API エンドポイントから取得したエンタープライズ コンテキストの要約など、生成された仕様に関する情報がチャット ウィンドウに表示されます。Cloud Code の他のタブには、仕様コードと、エンドポイント、スキーマ、新しい API 仕様に関するその他の情報を含む Swagger インターフェースが表示されます。

仕様のエンドポイントを示す Cloud Code の Gemini Code Assist チャット

ステップ 5: 仕様を変更する

複数の歯科医院の場所を含めるように仕様を変更します。まず、仕様を含む YAML ファイルが、エディタで現在アクティブなタブにあることを確認します。次に、チャット ウィンドウで Apigee ハンドルをもう一度入力し、Apigee ツール @Apigee を選択します。次のプロンプトを入力します。

@Apigee Update the API specification for the dental scheduling API. Add multiple dental office locations.

仕様の変更内容は、編集タブに差分がハイライト表示された形で示されます。編集タブで直接更新内容を入力してファイルを保存することで、仕様を変更することもできます。

Cloud Code の Gemini Code Assist によって編集されたコード

ステップ 6: API を API Hub に公開する

API の審査が完了して最終版になったら、API Hub に登録してデベロッパーが使用できるようにします。

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

ステップ 7: ローカル モックサーバーを使用して API をテストする

API のレスポンスをエミュレートするローカルモックサーバーを使用して API をテストします。ローカル モックサーバーは、API Hub への公開を必要としません。

[Servers] プルダウンでローカル モックサーバーがすでに選択されている必要があります。
Cloud Code の Gemini Code Assist における、プルダウン内のローカル モックサーバー

ローカル モックサーバーが選択されたら、[POST] パスを開き、[Try it out] をクリックします。

リクエスト本文の addresses エンティティに「city」、「country」、「postalCode」の値を指定します。

{
    "city": "string",
    "country": "string",
    "postalCode": "string",
    "state": "string",
    "streetAddress": "string"
  }

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

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

（省略可）この仕様から Apigee の API プロキシ バンドルを作成するには、[Create API proxy bundle] ボタンをクリックしてプロキシ名を入力します。作成後、Apigee ワークスペースの [apiproxies] に新しいプロキシが表示されます。Cloud Code での API プロキシの操作方法については、API プロキシの開発をご覧ください。

次のステップ