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. Unter Übersicht über die lokale Entwicklung mit Apigee finden Sie Informationen zu den Funktionen in der lokalen Entwicklungsumgebung.

Für die Einrichtung müssen beide Abschnitte dieser Anleitung durchgearbeitet werden:

Je nach Anwendungsfall müssen Sie auch API-Proxy-Entwicklung für die lokale Entwicklung mit Apigee einrichten durcharbeiten.

Hinweis

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

  1. Ein Google Cloud Projekt, in dem Sie sich in Ihrer lokalen Entwicklungsumgebung anmelden können. Das Projekt muss für Apigee bereitgestellt werden, damit Sie einen lokalen Apigee-Arbeitsbereich erstellen können, in dem Sie API-Proxys entwickeln und testen können.
  2. (Empfohlen) Apigee API Hub, der für Ihr Projekt bereitgestellt wurde. Mit der API Hub-Integration können Sie in Cloud Code auf APIs in Ihrem gesamten Ökosystem zugreifen und sie bearbeiten. API Hub ist auch für die Erstellung eines simulierten Remote-Servers zum Testen von API-Spezifikationen erforderlich.

    Wenn Sie API Hub nicht zu Ihrem Projekt hinzufügen möchten, können Sie das Projekt stattdessen mit einem anderen Projekt verknüpfen, in dem API Hub aktiviert ist. Unter Laufzeitprojekt an einen API Hub anhängen finden Sie Informationen zum Anhängen eines Projekts an einen API Hub.

    Unter Erforderliche Rollen für die Verwendung von API Hub mit der lokalen Entwicklung mit Apigee finden Sie die erforderlichen Rollen für die Aktionen, die Sie ausführen möchten.
  3. Kenntnisse in VS Code, zur Verwaltung von VS Code und zur Ausführung gängiger Aktionen wie dem Zugriff auf Einstellungen und der Installation von Erweiterungen. Weitere Informationen finden Sie in der VS Code-Dokumentation.

Erforderliche Rollen für die Verwendung von Apigee API Hub mit der lokalen Entwicklung mit Apigee

Sie benötigen die unten aufgeführten Rollen, um die Schritte zum API-Design und -Testen mit den Apigee API Hub-APIs auszuführen:

Aufgabe Erforderliche Rollen
API Hub-APIs aufrufen und bearbeiten Cloud API Hub-Administrator oder Cloud API Hub-Bearbeiter
APIs in API Hub veröffentlichen Cloud API Hub-Administrator oder Cloud API Hub-Bearbeiter
Simulierten Remote-Server zum Testen von APIs einrichten und verwalten Artifact Registry-Administrator
Cloud Build-Dienstkonto
Cloud Run-Administrator
Service Usage-Administrator

Weitere Informationen finden Sie unter Referenz zu grundlegenden und vordefinierten IAM-Rollen.

Außerdem muss die Google Cloud CLI installiert sein.

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 bei der Einrichtung der lokalen Entwicklung für Apigee und ist erforderlich, um die Funktionen für die lokale Entwicklung mit Apigee zu verwenden.

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

  1. Laden Sie Visual Studio Code (VS Code) auf Ihren lokalen Computer herunter und installieren Sie es, falls es 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 Updates und aktivieren Sie die Option für alle Erweiterungen oder einzeln für die Cloud Code-Erweiterung.
  4. Starten Sie VS Code neu.

API-Proxy-Entwicklung für die lokale Entwicklung mit 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 diese Schritte auch aus, um einen API-Proxy aus einer OpenAPI-Spezifikation zu erstellen.

  1. Erstellen Sie einen Apigee-Arbeitsbereich.
  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: