Freigeben über

Entwerfen und Entwickeln von APIs mithilfe des API Center-Plug-Ins für GitHub Copilot für Azure

  • Artikel

Das API Center-Plug-In für GitHub Copilot für Azure (Vorschau) beschleunigt das Entwerfen und Entwickeln neuer APIs beginnend mit Prompts in natürlicher Sprache. Mit KI-Unterstützung, die über das API Center-Plug-In in Kombination mit der API Center-Erweiterung für VS Code verfügbar ist, können Sie einfach Ihre API beschreiben und schnell eine OpenAPI-Spezifikation für die API-Entwicklung generieren, die den Standards Ihrer Organisation entspricht. Nachdem Sie eine kompatible Spezifikation generiert haben, können Sie die API im API Center registrieren.

Hinweis

Diese Funktion ist in der Vorabversion der API Center-Erweiterung verfügbar.

Voraussetzungen

Erweiterungssetup

  1. Installieren Sie die Azure API-Center-Erweiterung für Visual Studio Code aus dem Visual Studio Code Marketplace. Installieren Sie weitere Erweiterungen, die in den Voraussetzungen aufgeführt sind.

    Hinweis

    Sofern angegeben, stehen bestimmte Features nur in der Vorabversion der Azure API Center-Erweiterung zur Verfügung. Wenn Sie die Erweiterung aus dem Visual Studio Code Marketplace installieren, können Sie die endgültige Produktversion oder eine Vorabversion installieren. Wechseln Sie jederzeit zwischen den beiden Versionen, indem Sie das Kontextmenü der Erweiterungsschaltfläche Verwalten in der Erweiterungsansicht verwenden.

  2. Wählen Sie in Visual Studio Code auf der Aktivitätsleiste auf der linken Seite „API-Center“ aus.

    Screenshot: API Center-Erweiterung auf der Aktivitätsleiste

  3. Wenn Sie nicht bei Ihrem Azure-Konto angemeldet sind, wählen Sie Bei Azure anmelden… aus, und folgen Sie den Anweisungen, um sich anzumelden. Wählen Sie ein Azure-Abonnement mit dem API Center (oder den API-Centern) aus, von dem bzw. denen Sie APIs anzeigen möchten. Sie können auch nach bestimmten Abonnements filtern, wenn viele zum Anzeigen verfügbar sind.

Anforderungen an den @azure-Agent

Führen Sie die folgenden Schritte aus, um eine OpenAPI-Spezifikation mit Prompts in natürlicher Sprache mit GitHub Copilot für Azure zu generieren:

  1. Legen Sie bei Bedarf einen Leitfaden zum aktiven API-Styleguide in der Azure API Center-Erweiterung fest. Verwenden Sie die Tastenkombination STRG+UMSCHALT+P, um die Befehlspalette zu öffnen. Geben Sie Azure API Center: API-Styleguide festlegen ein, treffen Sie eine Auswahl und drücken Sie die EINGABETASTE.

    Wenn kein Styleguide festgelegt ist, wird der Standardregelsatz spectral:oas verwendet. Erfahren Sie mehr über das API-Spezifikationslinting mithilfe der API Center-Erweiterung.

  2. Senden Sie im Chatbereich eine Anforderung in natürlicher Sprache an den @azure-Agent, um zu beschreiben, was die API tut. Beispiel:

    @azure Generate an OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards. Check that there are no duplicate keys.

    Copilot wird von KI unterstützt. Daher sind Überraschungen und Fehler möglich. Weitere Informationen finden Sie unter Copilot-FAQs.

    Der Agent antwortet mit einem OpenAPI-Spezifikationsdokument.

    Screenshot, der zeigt, wie Sie die @azure-Erweiterung verwenden, um eine OpenAPI-Spezifikation aus einem Prompt zu generieren.

  3. Überprüfen Sie die generierte Ausgabe auf Genauigkeit und Vollständigkeit sowie auf Compliance mit Ihrem API-Styleguide.

    Verfeinern Sie den Prompt ggf., um die Spezifikation neu zu generieren, oder wiederholen Sie den Prozess mithilfe eines anderen Styleguides, den Sie in der Azure API Center-Erweiterung festlegen.

    Tipp

    Effektive Prompts konzentrieren sich nicht auf Implementierungsdetails, sondern auf die Geschäftsanforderungen einer API. Kürzere Prompts funktionieren manchmal besser als längere.

  4. Wenn sie Ihre Anforderungen erfüllt, speichern Sie die generierte OpenAPI-Spezifikation in einer Datei.

Registrieren der API im API Center

Verwenden Sie die Azure API Center-Erweiterung für VS Code, um die aus der generierten Spezifikationsdatei erstellte API im API Center zu registrieren. Nach der Registrierung der API können Sie die Erweiterung verwenden, um die API-Dokumentation anzuzeigen, einen HTTP-Client zu generieren, weitere Linting- und Analysevorgänge durchzuführen u. v. m.

  1. Wählen Sie im Chatbereich die Schaltfläche API im API Center registrieren oder in der Befehlspalette Azure API Center: API registrieren aus.

  2. Wählen Sie Manuell aus.

  3. Wählen Sie das API Center aus, bei dem APIs registriert werden sollen.

  4. Beantworten Sie die Eingabeaufforderungen mit Informationen wie API-Titel, Typ, Versionstitel, Versionslebenszyklus, Definitionstitel sowie Name und Definitionsdatei der Spezifikation, um die API-Registrierung abzuschließen.

Nachdem die API registriert wurde, können Sie mithilfe der Erweiterung verschiedene Aufgaben ausführen. Sie können z. B. auf der Swagger-Benutzeroberfläche die API-Dokumentation anzeigen:

  1. Erweitern Sie die API Center-Strukturansicht, um die Definition für die API-Version auszuwählen, die Sie registriert haben.

  2. Klicken Sie mit der rechten Maustaste auf die Definition, und wählen Sie API-Dokumentation öffnen aus. Eine neue Registerkarte mit der Swagger-Benutzeroberfläche für die API-Definition wird angezeigt.

Screenshot der Swagger-Benutzeroberfläche in der VS Code-Erweiterung

Zugehöriger Inhalt