Apigee API Management in Cloud Code für VS Code einrichten

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Auf dieser Seite finden Sie eine Anleitung zum Erstellen einer lokalen Entwicklungsumgebung für Apigee API Management in Cloud Code für VS Code, die Gemini Code Assist für das Design und die Entwicklung von OpenAPI-Spezifikationen unterstützt. Informationen zu den Funktionen der lokalen Entwicklungsumgebung finden Sie unter Übersicht über die lokale Entwicklung mit Apigee.

Für die Einrichtung müssen Sie beide Abschnitte dieser Anleitung durcharbeiten:

Je nach Anwendungsfall müssen Sie auch einen oder beide der folgenden Abschnitte ausfüllen:

Hinweise

Um Apigee in VS Code einzurichten und zu verwenden, benötigen Sie Folgendes:

  1. Ein Google Cloud Projekt, in dem Sie sich in Ihrer lokalen Entwicklungsumgebung anmelden. Das Projekt muss nicht für Apigee bereitgestellt werden, um API-Spezifikationen mit Gemini Code Assist zu entwickeln. Es muss jedoch für Apigee bereitgestellt werden, um einen lokalen Apigee-Arbeitsbereich zu erstellen, in dem Sie API-Proxys entwickeln und testen können. Die Apigee-Bereitstellung ist auch erforderlich, damit im Apigee-Bereich von Cloud Code Apigee API-Hub-APIs angezeigt werden.
  2. (Empfohlen) API-Hub, der in Ihrem Projekt bereitgestellt wurde. API-Hub ist für die folgenden Funktionen erforderlich: Wenn Sie Ihrem Projekt keinen API-Hub hinzufügen möchten, können Sie es stattdessen mit einem anderen Projekt verknüpfen, für das der API-Hub aktiviert ist. Informationen zum Anhängen eines Projekts an einen API-Hub finden Sie unter An einen API-Hub ein Laufzeitprojekt anhängen.
  3. Die erforderlichen Rollen für die Verwendung von Gemini Code Assist in Apigee für die Aktionen, die Sie ausführen möchten. Sie benötigen die Rolle Administrator für die Dienstnutzung für Ihr Nutzerkonto für das Projekt, um Gemini Code Assist einzurichten.
  4. Sie sollten mit VS Code vertraut sein und wissen, wie Sie VS Code verwalten und gängige Aktionen ausführen, z. B. auf Einstellungen zugreifen und Erweiterungen installieren. Weitere Informationen finden Sie in der VS Code-Dokumentation.

VS Code und die Cloud Code-Erweiterung installieren

In diesem Abschnitt finden Sie eine Anleitung zum Installieren von VS Code und der Cloud Code-Erweiterung in VS Code. Dies ist der erste Schritt bei der Einrichtung der lokalen Entwicklung für Apigee. Er ist erforderlich, um die Funktionen zur lokalen Entwicklung von Apigee zu verwenden, einschließlich Gemini Code Assist.

So installieren Sie VS Code und die Cloud Code-Erweiterung:

  1. Laden Sie den Visual Studio Code (VS Code) auf Ihren lokalen Computer herunter und installieren Sie ihn, falls er noch nicht installiert ist.
  2. Installieren Sie die Cloud Code-Erweiterung, wie unter Cloud Code-Erweiterung installieren beschrieben. Wenn Sie API-Proxys in Ihrer lokalen Umgebung verwalten möchten, installieren Sie Docker im Rahmen des Prozesses.
  3. (Empfohlen) Aktivieren Sie automatische Updates für die Cloud Code-Erweiterung. Suchen Sie in den Einstellungen nach Erweiterungen: Automatische Aktualisierung und aktivieren Sie diese Option für alle Erweiterungen oder einzeln für die Cloud Code-Erweiterung.
  4. Starten Sie VS Code neu.

Gemini Code Assist für Apigee einrichten

Führen Sie die folgenden Schritte aus, um Gemini Code Assist für Apigee in Ihrer lokalen Entwicklungsumgebung einzurichten. Beachten Sie die Rolle, die für die Verwendung von Gemini Code Assist in Apigee erforderlich ist.

  1. Führen Sie die Schritte unter VS Code und die Cloud Code-Erweiterung installieren aus, falls Sie dies noch nicht getan haben.
  2. Installieren Sie die Gemini Code Assist-Erweiterung in VS Code.
  3. (Empfohlen) Aktivieren Sie automatische Updates für die Gemini Code Assist-Erweiterung. Suchen Sie in den Einstellungen nach Erweiterungen: Automatisches Update und aktivieren Sie diese Option für alle Erweiterungen oder einzeln für die Gemini Code Assist-Erweiterung.
  4. Installieren Sie die gcloud CLI, falls noch nicht geschehen.
  5. Aktivieren Sie die Gemini for Google Cloud API für das Projekt. Sie benötigen die Rolle Administrator für die Dienstnutzung, um diesen Schritt ausführen zu können. 
    gcloud services enable cloudaicompanion.googleapis.com --project=YOUR_PROJECT
  6. Melden Sie sich in VS Code sowohl in der Gemini Code Assist- als auch in der Cloud Code-Erweiterung in Ihrem Google Cloud Projekt an. Sie haben dazu folgende Möglichkeiten:
    • Fügen Sie das Projekt manuell in Ihrer settings.json-Datei hinzu: 
      {
  "cloudcode.apigee.gemini.options": {
      "cloudcode.project": "YOUR_PROJECT",
      "geminicodeassist.project": "YOUR_PROJECT"
    ...
    }
  }
    • Wählen Sie auf Aufforderung das Projekt aus:

      Wenn Sie den Gemini Code Assist-Chat öffnen und nicht in einem Projekt mit aktiviertem Gemini angemeldet sind, wird eine entsprechende Meldung mit einer Möglichkeit zur Anmeldung angezeigt. Wählen Sie Google Cloud Projekt auswählen aus, um das Projekt hinzuzufügen.
      Fehlendes Projekt für Gemini Code Assist für Gemini Code Assist-Chat

      Wenn Sie ein Projekt für Google Cloud im Bereich Apigee in Cloud Code auswählen möchten, maximieren Sie den Bereich API-Hub und klicken Sie auf Cloud Code – Kein Projekt ausgewählt:
      Google Cloud kein Projekt

      Sie können auch in der Cloud Code-Statusleiste auf den Projektnamen klicken und das neue Projekt auswählen: Cloud Code-Statusleiste mit Apigee-Projekt
  7. Fügen Sie Ihrem Nutzerkonto alle erforderlichen Rollen hinzu, die zum Verwenden von Gemini Code Assist in Apigee erforderlich sind.
  8. Wenn Sie ein API-Proxy-Bundle aus einer OpenAPI-Spezifikation erstellen und in Ihrer lokalen Entwicklungsumgebung verwalten möchten, führen Sie die Schritte unter Lokale Entwicklungsumgebung für die API-Proxy-Entwicklung einrichten aus.

Erforderliche Rollen für die Verwendung von Gemini Code Assist in Apigee

Sie benötigen die unten aufgeführten Rollen, um mit Gemini Code Assist API-Design- und -Testschritte auszuführen:

Aufgabe Erforderliche Rollen
APIs mit Gemini Code Assist entwerfen Gemini for Google Cloud User
Service Usage Consumer

Weitere Informationen finden Sie unter IAM-Rollen in einem Google Cloud-Projekt für Gemini Code Assist gewähren.
Unternehmenskontext aus Ihren vorhandenen APIs im API-Hub beim Entwerfen von APIs verwenden Cloud API Hub-Betrachter
API-Hub-APIs bearbeiten Cloud API Hub-Bearbeiter oder ‑Administrator
APIs im API-Hub veröffentlichen Cloud API Hub-Bearbeiter oder ‑Administrator
Simulierter Remote-Server zum Testen von APIs einrichten und verwalten Artifact Registry-Administrator
Cloud Build-Dienstkonto
Cloud Run-Administrator
Service Usage-Administrator

Referenz zu grundlegenden und vordefinierten IAM-Rollen.

Außerdem muss die gcloud CLI installiert sein.

API-Proxy-Entwicklung für die lokale Entwicklung in Apigee einrichten

Führen Sie die Schritte in diesem Abschnitt aus, wenn Sie Ihre lokale Entwicklungsumgebung für die Entwicklung und das Testen von Apigee API-Proxy verwenden möchten. Führen Sie außerdem diese Schritte aus, um einen API-Proxy aus einer OpenAPI-Spezifikation erstellen zu können.

  1. Einen Apigee-Arbeitsbereich erstellen
  2. Installieren Sie den Apigee Emulator.
  3. Fügen Sie einen Container für die Bereitstellung im Apigee-Emulator hinzu.

Nächste Schritte

Nachdem Sie die Installation und Einrichtung abgeschlossen haben, können Sie Cloud Code verwenden: