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. Informationen zu den Funktionen in 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 API-Proxy-Entwicklung für die lokale Entwicklung von Apigee einrichten.

Hinweise

Für die Einrichtung und Verwendung von Apigee in VS Code benötigen Sie Folgendes:

  1. Ein Google Cloud -Projekt, in das Sie sich in Ihrer lokalen Entwicklungsumgebung einloggen können. Das Projekt muss für Apigee bereitgestellt werden, damit ein lokaler Apigee-Arbeitsbereich erstellt werden kann, in dem Sie API-Proxys entwickeln und testen können.
  2. (Empfohlen) API-Hub, der für Ihr Projekt bereitgestellt wurde. Der API-Hub ist erforderlich, um einen simulierten Remote-Server zum Testen von API-Spezifikationen zu erstellen.

    Wenn Sie den API-Hub nicht Ihrem Projekt hinzufügen möchten, können Sie das Projekt stattdessen einem anderen Projekt zuordnen, für das der API-Hub aktiviert ist. Informationen zum Anhängen eines Projekts an einen API-Hub finden Sie unter Laufzeitprojekt an einen API-Hub anhängen.
  3. Die erforderlichen Rollen für die Verwendung des API-Hubs mit der lokalen Apigee-Entwicklung für die Aktionen, die Sie ausführen möchten.
  4. Sie sind mit VS Code vertraut 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 die Installationsanleitung für VS Code und die Cloud Code-Erweiterung in VS Code. Dies ist der erste Schritt beim Einrichten der lokalen Entwicklung für Apigee und ist erforderlich, um die Apigee-Funktionen für die lokale Entwicklung zu verwenden.

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 die Option für alle Erweiterungen oder für die Cloud Code-Erweiterung.
  4. Starten Sie VS Code neu.

Erforderliche Rollen für die Verwendung des Apigee API-Hubs mit der lokalen Apigee-Entwicklung

Sie benötigen die unten aufgeführten Rollen, um API-Design- und Testschritte mit dem Apigee API-Hub auszuführen:

Aufgabe Erforderliche Rolle(n)
API-Hub-APIs ansehen und 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 Apigee-Entwicklung 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 diese Schritte auch aus, um einen API-Proxy aus einer OpenAPI-Spezifikation erstellen zu können.

  1. Apigee-Arbeitsbereich erstellen
  2. Apigee Emulator installieren
  3. Container für die Bereitstellung im Apigee Emulator hinzufügen

Nächste Schritte

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