Freigeben über

Erstellen und Registrieren von APIs mit der Azure API Center-Erweiterung für Visual Studio Code

  • Artikel

API-Entwickler in Ihrer Organisation können APIs in Ihrem API Center-Bestand erstellen und registrieren, indem sie die Azure API Center-Erweiterung für Visual Studio Code verwenden. API-Entwickler können:

  • Einem API-Center eine vorhandene API einmalig hinzufügen oder eine Entwicklungspipeline integrieren, um APIs als Teil eines CI/CD-Workflows zu registrieren.
  • OpenAPI-Spezifikationsdateien aus API-Code mithilfe von GitHub Copilot generieren und die API in einem API Center registrieren.

API-Entwickler können auch Features in der Erweiterung nutzen, um APIs im API Center zu entdecken und zu nutzen und API-Governance sicherzustellen.

Voraussetzungen

Die folgenden Visual Studio Code-Erweiterungen sind für die angegebenen Szenarien erforderlich:

  • GitHub Actions – zum Registrieren von APIs mithilfe einer CI/CD-Pipeline mit GitHub Actions
  • Azure Pipelines – zum Registrieren von APIs mithilfe einer CI/CD-Pipeline mit Azure Pipelines
  • GitHub Copilot – zum Generieren von OpenAPI-Spezifikationsdateien aus API-Code

Setup

  1. Installieren Sie die Azure API-Center-Erweiterung für Visual Studio Code aus dem Visual Studio Code Marketplace. Installieren Sie bei Bedarf andere Erweiterungen.

    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 der 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.

Registrieren einer API – Schritt für Schritt

Die folgenden Schritte registrieren eine API im API Center als einmaligen Vorgang.

  1. Verwenden Sie die Tastenkombination STRG+UMSCHALT+P, um die Befehlspalette zu öffnen. Geben Sie Azure API Center: Register API ein, und drücken Sie die Eingabetaste.
  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, Spezifikationsname und Definitionsdatei, um die API-Registrierung abzuschließen.

Die API wird Ihrem API Center-Bestand hinzugefügt.

Registrieren von APIs – CI/CD-Pipeline

Die folgenden Schritte registrieren eine API im API Center mit einer CI/CD-Pipeline. Fügen Sie mit dieser Option eine vorkonfigurierte GitHub- oder Azure DevOps-Pipeline zu Ihrem aktiven Visual Studio Code-Arbeitsbereich hinzu, der als Teil eines CI/CD-Workflows für jeden Commit zur Quellcodeverwaltung ausgeführt wird. Es wird empfohlen, APIs mit Ihrem API-Center mithilfe von CI/CD zu inventarisieren, um sicherzustellen, dass API-Metadaten, einschließlich Spezifikation und Version, im API-Center auf dem neuesten Stand bleiben, während die API im Laufe der Zeit weiterentwickelt wird.

  1. Verwenden Sie die Tastenkombination STRG+UMSCHALT+P, um die Befehlspalette zu öffnen. Geben Sie Azure API Center: Register API ein, und drücken Sie die Eingabetaste.
  2. Wählen Sie CI/CD aus.
  3. Wählen Sie entweder GitHub oder Azure DevOpsaus, je nachdem, welchen Mechanismus zur Quellcodeverwaltung Sie bevorzugen. Ein Visual Studio Code-Arbeitsbereich muss geöffnet sein, damit die Azure API-Center-Erweiterung Ihrem Arbeitsbereich eine Pipeline hinzufügen kann. Nachdem die Datei hinzugefügt wurde, führen Sie die Schritte aus, die in der CI/CD-Pipelinedatei selbst dokumentiert sind, um die erforderliche Umgebungsvariablen und Identitäten zu konfigurieren. Beim Push zur Quellcodeverwaltung wird die API in Ihrem API Center registriert.

Erfahren Sie mehr über das Einrichten eines GitHub Actions-Workflows zum Registrieren von APIs im API Center.

Generieren einer OpenAPI-Spezifikationsdatei aus API-Code

Verwenden Sie die Leistungsfähigkeit von GitHub Copilot mit der Azure API Center-Erweiterung für Visual Studio Code, um eine OpenAPI-Spezifikationsdatei aus Ihrem API-Code zu erstellen. Klicken Sie mit der rechten Maustaste auf den API-Code, wählen Sie Copilot aus den Optionen aus, und wählen Sie API-Dokumentation generieren aus. GitHub Copilot erstellt eine OpenAPI-Spezifikationsdatei.

Hinweis

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

Animation, die zeigt, wie GitHub Copilot zum Generieren einer OpenAPI-Spezifikation aus Code verwendet wird.

Nach dem Generieren der OpenAPI-Spezifikationsdatei und der Überprüfung auf Genauigkeit können Sie die API für Ihr API Center mit dem Befehl Azure API Center: API registrieren registrieren.

Zugehöriger Inhalt