Anmerkung
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
GILT FÜR: Alle API Management-Ebenen
Es gibt Situationen, in denen es für alle API-Verbraucher unpraktisch ist, dieselbe Version zu verwenden. Wenn Verbraucher bereit sind, auf eine neuere Version zu aktualisieren, bevorzugen sie einen einfachen und verständlichen Ansatz. Wie in diesem Lernprogramm gezeigt, unterstützt Azure API Management das Verfügbarmachen mehrerer API-Versionen, um diesen Bedarf zu erfüllen.
Hintergrundinformationen finden Sie unter Versionen und Revisionen.
Tipp
API-Teams können dieses Feature in Arbeitsbereichen verwenden. Arbeitsbereiche bieten isolierten Administrationszugriff auf APIs und ihre eigenen API-Runtimeumgebungen.
In diesem Tutorial lernen Sie Folgendes:
- Hinzufügen einer neuen Version zu einer vorhandenen API
- Auswählen eines Versionsschemas
- Hinzufügen der Version zu einem Produkt
- Version im Entwicklerportal ansehen
Voraussetzungen
- Lernen Sie die Terminologie der Azure-API-Verwaltung kennen.
- Absolvieren Sie den Schnellstart Erstellen einer Azure API Management-Instanz.
- Schließen Sie das Lernprogramm zum Importieren und Veröffentlichen Ihrer ersten API ab.
Hinzufügen einer neuen Version
- Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.
- Wählen Sie im linken Menü im Abschnitt APIsAPIs aus.
- Suchen Sie Swagger Petstore - OpenAPI 3.0 in der API-Liste. Wählen Sie die Auslassungspunkte (...) neben Swagger Petstore - OpenAPI 3.0 und dann Version hinzufügen aus. Sie fügen dem resultierenden Fenster im nächsten Abschnitt Werte hinzu.
Tipp
Sie können Versionen auch aktivieren, wenn Sie eine neue API erstellen. Wählen Sie auf dem Bildschirm API hinzufügen die Option Versionsverwaltung für diese API? aus.
Auswählen eines Schemas für die Versionsverwaltung
In der API-Verwaltung wählen Sie aus, wie Aufrufer die API-Version angeben, indem Sie ein Versionsverwaltungsschema auswählen: Pfad, Header oder Abfragezeichenfolge. Im folgenden Beispiel wird Path als Versionsverwaltungsschema verwendet.
Geben Sie im Fenster "Neue API als Version erstellen " die Werte aus der folgenden Tabelle ein. Wählen Sie anschließend Erstellen aus, um Ihre Version zu erstellen.
| Einstellung | Wert | Beschreibung |
|---|---|---|
| Versionsbezeichner | v1 | Schemaspezifischer Indikator der Version. Für Pfad wird das Suffix für den API-URL-Pfad verwendet. |
| Versionsverwaltungsschema | Pfad | Die Art und Weise, wie Aufrufer die API-Version angeben. Wenn Sie "Header" oder " Abfragezeichenfolge" auswählen, geben Sie einen anderen Wert ein: den Namen des Header- oder Abfragezeichenfolgenparameters. Ein Verwendungsbeispiel wird angezeigt. |
| Vollständiger Name der API-Version | swagger-petstore-openapi-3-0-v1 | Eindeutiger Name in Ihrer API Management-Instanz. Da eine Version tatsächlich eine neue API ist, die auf der Überarbeitung einer API basiert, ist dieser Wert der Name der neuen API. |
| Produkte | Unbegrenzt (in einigen Dienstebenen bereitgestellt) | Optional ein oder mehrere Produkte, mit denen die API-Version verknüpft ist. Zur Veröffentlichung der API muss sie einem Produkt zugeordnet werden. Sie können die Version auch später einem Produkt hinzufügen. |
Nachdem Sie die Version erstellt haben, wird sie unter Swagger Petstore - OpenAPI 3.0 in der API-Liste angezeigt. Nun werden zwei APIs angezeigt: Original und v1:
Hinweis
Wenn Sie einer nicht versionsgesteuerten API eine Version hinzufügen, wird auch automatisch eine originale Version erstellt. Diese Version reagiert auf die Standard-URL. Die ursprüngliche Version stellt sicher, dass Anrufe von vorhandenen Anrufern nach dem Hinzufügen der Version weiterhin funktionieren. Wenn Sie eine neue API mit aktivierten Versionen am Anfang erstellen, wird kein Original erstellt.
Bearbeiten einer Version
Nachdem Sie die Version hinzugefügt haben, können Sie sie als API bearbeiten und konfigurieren, die vom Original getrennt ist. Änderungen an einer Version wirken sich nicht auf eine andere (z. B. wenn Sie API-Vorgänge hinzufügen oder entfernen oder die OpenAPI-Spezifikation bearbeiten). Weitere Informationen finden Sie unter Bearbeiten einer API.
Hinzufügen der Version zu einem Produkt
Damit Anrufer die neue Version sehen können, muss sie einem Produkt hinzugefügt werden. Wenn Sie die Version noch nicht zu einem Produkt hinzugefügt haben, können Sie dies jederzeit tun.
So fügen Sie die Version zu einem Produkt hinzu:
- Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.
- Wählen Sie unter "APIs " im linken Bereich " Produkte" aus.
- Wählen Sie das Produkt aus, und wählen Sie dann im linken Bereich APIs aus.
- Klicken Sie auf + Hinzufügen.
- Wählen Sie die API aus.
- Klicken Sie auf Auswählen.
Verwenden von Versionsgruppen
Beim Erstellen mehrerer Versionen wird vom Azure-Portal eine Versionsgruppe erstellt. Diese stellt eine Gruppe von Versionen für eine einzelne logische API dar. Wenn Sie den Namen einer API auswählen, die über mehrere Versionen verfügt, zeigt das Portal den Versionssatz an. Sie können den Namen und die Beschreibung eines Versionssatzes anpassen.
Mithilfe der Azure CLI können Sie direkt mit Versionsgruppen interagieren:
Verwenden Sie die Bash-Umgebung in Azure Cloud Shell. Weitere Informationen finden Sie unter "Erste Schritte mit Azure Cloud Shell".
Wenn Sie CLI-Referenzbefehle lieber lokal ausführen, installieren Sie die Azure CLI. Wenn Sie Windows oder macOS ausführen, sollten Sie die Azure CLI in einem Docker-Container ausführen. Weitere Informationen finden Sie unter Ausführen der Azure CLI in einem Docker-Container.
Wenn Sie eine lokale Installation verwenden, melden Sie sich mithilfe des Befehls az login bei der Azure CLI an. Um den Authentifizierungsprozess abzuschließen, führen Sie die in Ihrem Terminal angezeigten Schritte aus. Weitere Anmeldeoptionen finden Sie unter Authentifizieren bei Azure mithilfe der Azure CLI.
Installieren Sie die Azure CLI-Erweiterung bei der ersten Verwendung, wenn Sie dazu aufgefordert werden. Weitere Informationen zu Erweiterungen finden Sie unter Verwenden und Verwalten von Erweiterungen mit der Azure CLI.
Führen Sie az version aus, um die installierte Version und die abhängigen Bibliotheken zu ermitteln. Führen Sie az upgrade aus, um ein Upgrade auf die neueste Version durchzuführen.
Führen Sie zum Anzeigen aller Versionsgruppen den Befehl az apim api versionset list aus:
az apim api versionset list --resource-group <resource-group-name> \
--service-name <API-Management-service-name> --output table
Wird vom Azure-Portal eine Versionsgruppe für Sie erstellt, wird dabei ein alphanumerischer Name zugewiesen. Dieser wird in der Spalte Name der Liste angezeigt. Verwenden Sie diesen Namen in anderen Azure CLI-Befehlen.
Führen Sie den Befehl az apim api versionset show aus, um Details zu einer Versionsgruppe anzuzeigen:
az apim api versionset show --resource-group <resource-group-name> \
--service-name <API-Management-service-name> --version-set-id <ID from the Name column>
Weitere Informationen zu Versionsgruppen finden Sie unter Versionen in Azure API Management.
Version im Entwicklerportal anzeigen.
Wenn Sie das Entwicklerportal verwenden, werden dort API-Versionen angezeigt.
- Wählen Sie oben im Fenster das Entwicklerportal aus.
- Wählen Sie APIs und dann Swagger Petstore aus.
- Es sollte eine Dropdownliste angezeigt werden, die mehrere Versionen neben dem API-Namen auflistet.
- Wählen Sie v1 aus.
- Beachten Sie die Anforderungs-URL des ersten Vorgangs in der Liste. Dort sehen Sie, dass der API-URL-Pfad v1 enthält.
Nächster Schritt
Gehen Sie zum nächsten Tutorial über: