Anleitung: APIs in Apigee und Cloud Code mit Gemini Code Assist entwerfen, entwickeln und testen

Diese Seite gilt für Apigee und Apigee Hybrid.

Übersicht

In dieser Anleitung erfahren Sie, wie Sie mit Gemini Code Assist in Cloud Code eine API entwerfen und einen Apigee API-Proxy aus einer generierten API-Spezifikation erstellen. Sie verwenden einen Prompt in natürlicher Sprache, um eine API zu entwerfen und zu erstellen, die sportbezogene Blogbeiträge für eine Website verwaltet.

Hinweise

Für diese Anleitung ist Folgendes erforderlich:

  • Die Gemini for Google Cloud API wurde für Ihr Apigee-Projekt eingerichtet oder Sie sind Administrator einer Apigee-Organisation, sodass Sie sie hinzufügen können. Informationen zur Einrichtung von Gemini Code Assist finden Sie unter Gemini Code Assist verwenden.
  • Sie müssen Apigee API-Administrator für Ihr Apigee-Projekt sein.
  • Richten Sie die lokale Entwicklung für Ihr Apigee-Projekt in Cloud Code ein, falls Sie dies noch nicht getan haben. Weitere Informationen finden Sie unter Apigee API Management in Cloud Code für VS Code einrichten.
  • Vertrautheit mit OpenAPI-Spezifikationen, damit Sie die generierte Spezifikation prüfen können.
  • (Optional) API-Hub ist für dieses Projekt eingerichtet. Obwohl die Verwendung der hier beschriebenen Gemini Code Assist-Funktionen nicht unbedingt erforderlich ist, können Sie nicht alle Schritte ohne API-Hub ausführen.

Schritt 1: Apigee in Cloud Code laden

Öffnen Sie VS Code und klicken Sie auf das Cloud Code-Symbol. Sie sollten Ihr Apigee-Projekt und alle APIs sehen.

Menü auf der linken Seite „Cloud Code Gemini Code Assist“

Schritt 2: Tab API-Spezifikation erstellen öffnen und Prompt eingeben

Klicken Sie in der Zeile Apigee auf den Zauberstab, um den Tab zum Erstellen von Spezifikationen zu öffnen.

Cloud Code Gemini Code Assist-Zauberstab zum Erstellen von Spezifikationen

Auf dem Tab werden Vorlagen angezeigt, mit denen Sie Ihren API-Prompt erstellen können. Darunter befindet sich ein Eingabefeld für Prompts im freien Format. Klicken Sie auf API für Bloginhalte. Ein Prompt in natürlicher Sprache, die diese API beschreibt, wird in das Eingabefeld für die Prompts ausgefüllt.

Cloud Code Gemini Code Assist-Formular zum Erstellen einer Spezifikation

Schritt 3: Spezifikation erstellen und ansehen

Klicken Sie auf Erstellen, um aus diesem Prompt eine API-Spezifikation zu generieren. Warten Sie, während die Spezifikation generiert wird. Im Bereich Output werden die Schritte während der Erstellung der Spezifikation angezeigt.

Sehen Sie sich nach der Erstellung die Spezifikationsbeschreibung, Endpunkte und Schemas an, indem Sie nach unten scrollen. Klicken Sie auf Code anzeigen, um den OpenAPI-Spezifikationscode aufzurufen.

Cloud Code Gemini Code Assist-Spezifikationsendpunkte

Schritt 4: Prompt ändern und Spezifikation neu erstellen

Kehren Sie zur Eingabeaufforderung zurück und fügen Sie dem Datenobjekt den Sporttyp hinzu.

Cloud Code Gemini Code Assist, bearbeiteten Prompt

Klicken Sie noch einmal auf Erstellen, um die Spezifikation neu zu generieren. Der Sporttyp wird dann in der aktualisierten Spezifikation angezeigt.

Sie können auch zum vorherigen Prompt zurückkehren, indem Sie oben im Prompt-Eingabefeld auf den Prompt-Verlauf klicken.

Schritt 5: Spezifikation bearbeiten

Sie können die Spezifikation ändern, indem Sie auf Code ansehen klicken und die Aktualisierungen direkt in die Spezifikation eingeben. Ändern Sie für dieses Beispiel die Beschreibung in „Sports Blog Post Content Management API“.

Von Cloud Code Gemini Code Assist bearbeiteter Code

Schritt 6: API mit einem Mock-Server testen

Testen Sie die API mit dem lokalen simulierten Server, der Antworten für die API emuliert. Wählen Sie im Drop-down-Menü Server die Option mit Lokaler Entwicklungsserver im Namen aus. Öffnen Sie nach der Auswahl den Pfad POST und klicken Sie auf Jetzt testen.

Ändern Sie die Werte "author", "content" und "title" im Anfragetext so, dass Ihre eigenen Werte verwendet werden:

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

Klicken Sie auf Ausführen, um im Abschnitt Antworten eine Simulationsantwort von der API anzusehen.

Schritt 7: API im API-Hub speichern

Nachdem Ihre API überprüft wurde und fertig ist, können Sie sie für Entwickler verfügbar machen, indem Sie sie im API-Hub registrieren:

  1. Klicken Sie auf Im API-Hub registrieren.
  2. Folgen Sie den Aufforderungen zur Registrierung der API. Informationen zur Registrierung im API-Hub und die Art der von Ihnen bereitzustellenden Informationen finden Sie unter APIs registrieren.

Klicken Sie auf Speichern, um die neue API mit einem Namen Ihrer Wahl zu speichern.

Schritt 8: API-Proxy-Bundle aus dieser Spezifikation erstellen

Klicken Sie im Menü Mehr auf API-Proxy-Bundle erstellen, um ein Apigee API-Proxy-Bundle aus dieser Spezifikation zu erstellen. Nach dem Erstellen sollte der neue Proxy im Menü auf der linken Seite unter apiproxies angezeigt werden. Weitere Informationen zur Arbeit mit API-Proxys in Cloud Code finden Sie unter API-Proxys entwickeln.
Cloud Code Gemini Code Assist – API-Proxy-Bundle erstellen

Nächste Schritte