Versionsübersicht

Diese Seite gilt für Apigee und Apigee Hybrid.

Vorschau — Apigee API hub

Diese Funktion unterliegt den „Nutzungsbedingungen für Pre-GA-Angebote“ im Abschnitt „Allgemeine Nutzungsbedingungen“ der dienstspezifischen Nutzungsbedingungen. Pre-GA-Funktionen sind „wie besehen“ verfügbar und werden möglicherweise nur eingeschränkt unterstützt. Weitere Informationen finden Sie in den Beschreibungen der Startphase.

In diesem Thema wird erläutert, was Sie über das Erstellen und Verwalten von Versionen im API Hub wissen müssen.

Was ist eine Version?

Jeder API-Ressource im API-Hub ist mindestens eine Version zugeordnet. Sie können sich eine Version als den Zustand einer API zu einem bestimmten Zeitpunkt vorstellen. Im Grunde helfen Versionen Ihnen dabei, Ihre APIs basierend auf zugrunde liegenden Vorgängen, Bereitstellungen und anderen Attributen zu gruppieren und zu organisieren.

Im API-Hub stellt eine Version eine logische Gruppierung von APIs dar. Normalerweise, aber nicht unbedingt, dreht sich diese Gruppierung um die Vorgänge, die eine API ausführen kann. Angenommen, Sie haben eine Pet Store API. Mit der ersten Version dieser API können Sie grundlegende Aufgaben ausführen, z. B. ein Haustier hinzufügen, ein Haustier suchen und ein Haustier aus dem Shop löschen. Dies sind Beispiele für Vorgänge.

Es empfiehlt sich, dass eine Version eine Reihe von API-Vorgängen enthält, die gemeinsam bereitgestellt werden. Eine API für den Tierbedarf kann beispielsweise eine Version haben, die Vorgänge zum Hinzufügen, Suchen und Löschen umfasst, die alle in denselben Umgebungen bereitgestellt werden.

Eine Version stellt die Sicht des API-Erstellers auf die API dar. Es handelt sich hierbei um die Sammlung von Funktionen, die die Personen, die die API erstellt haben, bereitstellen und erwartet wird, dass sie mit ihr bereitgestellt wird.

Versionen erstellen

Angenommen, die Details einer API, die Sie dem API-Hub hinzufügen möchten, werden in einer OpenAPI-Spezifikation erfasst. In diesem Fall können Sie die Spezifikation einer API-Version hinzufügen. Dabei parst der API-Hub die Spezifikation und ruft Informationen daraus ab, z. B. welche Vorgänge in der API enthalten sind, und speichert diese Informationen mit der Version. Auch wenn Sie keine OpenAPI-Spezifikation haben, können Sie trotzdem eine Version erstellen, müssen diese dann aber manuell mit relevanten beschreibenden Informationen füllen. Ein anderer Fall, in dem der API-Hub das Parsen von API-Details über die automatische Registrierung von Apigee API-Proxys unterstützt.

Hinweis: Im öffentlichen Vorschaurelease unterstützt der API-Hub nur das Parsen von OpenAPI-Spezifikationen.

Sie können mehrere API-Spezifikationsdateien in dieselbe Version hochladen.

Hinweis: API Hub kann nicht die Stabilität einer API garantieren, die von einem API-Ersteller bereitgestellt wird. Der API-Hub geht davon aus, dass alle in einer API-Version enthaltenen Vorgänge zusammen bereitgestellt werden sollen.

Wann sollte ich eine neue Version erstellen?

Wenn einer API neue Vorgänge hinzugefügt werden, sollte das Erstellen einer neuen Version rechtfertigen.

Angenommen, der API-Ersteller fügt einer API einen neuen Vorgang hinzu und möchte, dass dieser in allen Bereitstellungen, die derzeit der Version zugeordnet sind, bereitgestellt werden soll. In diesem Fall kann der Ersteller keine neue Version der API erstellen. Wenn der Ersteller dagegen eine nicht abwärtskompatible Änderung vornimmt (eine nicht abwärtskompatible Änderung) und sie einer neuen Bereitstellung zuordnen möchte, möchten Sie möglicherweise eine neue Version erstellen.

Sie sehen, dass Sie mit dem API-Hub die API-Versionen flexibel definieren und organisieren können, um sie optimal an die Anforderungen Ihrer Organisation und die Anforderungen bestimmter API-Ersteller anzupassen.

Systemattribute

Versionen enthalten standardmäßig die folgenden Systemattribute. Sie können die mit diesen Attributen verknüpften Werte in den Einstellungen ändern. Weitere Informationen finden Sie unter Attribute verwalten.

Attribut	Beschreibung
API-Lebenszyklusphase	Der Lebenszyklus bezieht sich auf einen geordneten Satz von Phasen, die eine API durchlaufen soll, von der Konzeption bis zum Ende des Produktzyklus. Da sich jede Version einer API in der Regel separat durch ihren eigenen Lebenszyklus bewegt, legen wir die Lebenszyklusphase einer API nicht direkt fest, sondern lassen stattdessen jede API-Version über eine zugewiesene Lebenszyklusphase verfügen.
Dokumentation	Ein Link zur Dokumentation für die API, an die die Version angehängt ist.
Compliance	Unter Einstellungen können Sie Werte definieren, die die für Ihr Team oder Ihre Organisation relevanten Compliance-Details darstellen. Weitere Informationen finden Sie unter Attribute verwalten.
Akkreditierung	In den Einstellungen können Sie Werte definieren, um die relevanten Akkreditierungsdetails für Ihr Team oder Ihre Organisation darzustellen. Weitere Informationen finden Sie unter Attribute verwalten.

Benutzerdefinierte Attribute

Je nach Team oder Organisationsanforderungen können Sie benutzerdefinierte Attribute (Name/Wert-Paare) für Versionen definieren. Weitere Informationen finden Sie unter Attribute verwalten.