Veröffentlichen mehrerer Versionen Ihrer APIPublish multiple versions of your API

Manchmal ist es unpraktisch, wenn alle Aufrufer genau die gleiche Version Ihrer API verwenden müssen.There are times when it is impractical to have all callers to your API use exactly the same version. Wenn Aufrufer auf eine höhere Version upgraden möchten, möchten Sie dafür einen leicht verständlichen Ansatz verwenden.When callers want to upgrade to a later version, they want to be able to do this using an easy to understand approach. Dies ist mit Versionen in Azure API Management möglich.It is possible to do this using versions in Azure API Management. Weitere Informationen finden Sie unter Versions & revisions (Versionen und Revisionen).For more information, see Versions & revisions.

In diesem Tutorial lernen Sie Folgendes:In this tutorial, you learn how to:

  • Hinzufügen einer neuen Version zu einer vorhandenen APIAdd a new version to an existing API
  • Auswählen eines VersionsschemasChoose a version scheme
  • Hinzufügen der Version zu einem ProduktAdd the version to a product
  • Anzeigen der Version im EntwicklerportalBrowse the developer portal to see the version

Angezeigte Version im Entwicklerportal

VoraussetzungenPrerequisites

Hinzufügen einer neuen VersionAdd a new version

API-Kontextmenü – Version hinzufügen

  1. Wählen Sie in der API-Liste Demo Conference API aus.Select Demo Conference API from the API list.
  2. Klicken Sie auf das Kontextmenü ( ... ) daneben.Select the context menu (...) next to it.
  3. Klicken Sie auf + Version hinzufügen.Select + Add Version.

Tipp

Versionen können auch beim Erstellen einer neuen API aktiviert werden. Wählen Sie hierzu auf dem Bildschirm API hinzufügen die Option Versionsverwaltung für diese API? aus.Versions can also be enabled when you first create a new API - select Version this API? on the Add API screen.

Auswählen eines Schemas für die VersionsverwaltungChoose a versioning scheme

Mit Azure API Management können Sie auswählen, wie Aufrufer angeben können, welche Version Ihrer API sie verwenden möchten.Azure API Management allows you to choose the way in which you allow callers to specify which version of your API they want. Zur Angabe der zu verwendenden API-Version wählen Sie ein Schema für die Versionsverwaltung aus.You specify which API version to use by selecting a versioning scheme. Mögliche Optionen für dieses Schema sind Pfad, Header oder Abfragezeichenfolge.This scheme can be either path, header or query string. Im folgenden Beispiel wird zur Wahl des Schemas für die Versionsverwaltung die Pfadoption verwendet.In the following example, path is used to select the versioning scheme.

Bildschirm zum Hinzufügen von Versionen

  1. Lassen Sie Pfad als Schema für Versionsverwaltung ausgewählt.Leave path selected as your versioning scheme.

  2. Geben Sie demo-conference-api-v1 in das Feld Name ein.Type demo-conference-api-v1 in the Name field.

    Hinweis

    Die Version ist tatsächlich eine neue API, die auf der API-Revision basiert.Version is in fact a new API based off an API's revision. Name ist der Name der neuen API. Er muss in der gesamten API Management-Instanz eindeutig sein.Name is the new API's name and it must be unique across API Management instance.

  3. Geben Sie v1 in das Feld Versionsbezeichner ein.Type v1 in the Version identifier field.

    Tipp

    Wenn Sie Header oder Abfragezeichenfolge als Schema für die Versionsverwaltung auswählen, müssen Sie einem zusätzlichen Wert (den Namen des Headers oder Abfragezeichenfolgen-Parameters) angeben.If you select header or query string as a versioning scheme, you need to provide an additional value - the name of the header or query string parameter.

  4. Klicken Sie auf Erstellen, um Ihre neue Version einzurichten.Select Create to set up your new version.

  5. In der API-Liste werden unter Demo Conference API nun zwei unterschiedliche APIs angezeigt: Original und v1.Underneath Demo Conference API in the API List, you now see two distinct APIs - Original, and v1.

    Unter einer API aufgeführte Versionen im Azure-Portal

    Hinweis

    Wenn Sie einer API ohne Versionsverwaltung eine Version hinzufügen, wird automatisch ein Original erstellt, das auf die Standard-URL reagiert.If you add a version to a non-versioned API, an Original will be automatically created - responding on the default URL. Dadurch wird sichergestellt, dass bereits vorhandene Aufrufer durch das Hinzufügen einer Version nicht beeinträchtigt werden.This ensures that any existing callers are not broken by the process of adding a version. Wenn Sie Versionen gleich bei der Erstellung einer neuen API aktivieren, wird kein Original erstellt.If you create a new API with versions enabled at the start, an Original is not created.

  6. Nun können Sie v1 als eine API bearbeiten und konfigurieren, die vom Original getrennt ist.You can now edit and configure v1 as an API that is separate to Original. Änderungen an einer Version haben keine Auswirkungen auf die andere.Changes to one version do not affect another.

Hinzufügen der Version zu einem ProduktAdd the version to a product

Damit Aufrufern die neue Version angezeigt wird, muss sie einem Produkt hinzugefügt werden.In order for callers to see the new version, it must be added to a product.

API Management-Produkte

  1. Klicken Sie auf der Seite des klassischen Bereitstellungsmodells auf Produkte.Select Products from the classic deployment model page.
  2. Klicken Sie auf Unbegrenzt.Select Unlimited.
  3. Klicken Sie auf APIs.Select APIs.
  4. Wählen Sie Hinzufügen.Select Add.
  5. Wählen Sie Demo Conference API, Version v1 aus.Select Demo Conference API, Version v1.
  6. Klicken Sie auf Auswählen.Click Select.

Anzeigen der Version im EntwicklerportalBrowse the developer portal to see the version

  1. Klicken Sie im oberen Menü auf Entwicklerportal.Select Developer Portal from the top menu.
  2. Wählen Sie APIs aus, und klicken Sie auf die Demo Conference API.Select APIs and click on the Demo Conference API.
  3. Ein Dropdownmenü mit mehreren Versionen neben dem API-Namen sollte angezeigt werden.You should see a dropdown with multiple versions next to the API name.
  4. Klicken Sie auf v1.Select v1.
  5. Beachten Sie die Anforderungs-URL des ersten Vorgangs in der Liste.Notice the Request URL of the first operation in the list. Dort sehen Sie, dass der API-URL-Pfad v1 enthält.It shows that the API URL path includes v1.

Nächste SchritteNext steps

In diesem Tutorial lernen Sie Folgendes:In this tutorial, you learn how to:

  • Hinzufügen einer neuen Version zu einer vorhandenen APIAdd a new version to an existing API
  • Auswählen eines VersionsschemasChoose a version scheme
  • Hinzufügen der Version zu einem ProduktAdd the version to a product
  • Anzeigen der Version im EntwicklerportalBrowse the developer portal to see the version

Fahren Sie mit dem nächsten Tutorial fort:Advance to the next tutorial: