Arbeiten mit mehreren Versionen

API Designer ermöglicht Ihnen die Arbeit mit mehreren Versionen derselben API-Definition, um Sie bei der Verwaltung des API-Lebenszyklus zu unterstützen. Sie haben folgende Möglichkeiten:

Weiterbetrieb einer bestehenden API-Version in der Produktion, während Sie in einer neuen Version umfangreiche oder nicht abwärtskompatible Änderungen einführen
Erlangung von Transparenz und Kontrolle über veröffentlichte Versionen.
Erlangung von Flexibilität beim Entwerfen von API-Änderungen.

Wenn Sie eine neue Version einer API erstellen, wird der gesamte Inhalt in die neue Version kopiert. Danach können die einzelnen Versionen unabhängig voneinander geändert werden, ohne sich gegenseitig zu beeinflussen.

Die Startseite des API Designers zeigt alle APIs an, deren Eigentümer Sie sind, und alle API-Versionen, die mit Ihnen geteilt wurden.

Erstellen einer neuen API-Version

Erstellen Sie eine neue Version einer vorhandenen API-Definition.

Sie sind Besitzer der API oder Bearbeiter mindestens einer Version der API.

Navigieren Sie auf der Startseite zu der API, für die Sie eine neue Version erstellen möchten.
Sie können die Liste bei Bedarf nach Name oder Besitzer filtern.
Klicken Sie auf die Schaltfläche neben der zu kopierenden Version und dann auf Create a new version from <version> (Neue Version aus <version> erstellen).
Geben Sie die neue Version ein.
Klicken Sie auf Create (Erstellen).

Eine neue Version Ihrer API wird mit demselben Inhalt wie die Quellversion erstellt. Der Mock und die Dokumentation sind standardmäßig deaktiviert.

Löschen einer API-Version

Sie sind ein Besitzer der API.

Klicken Sie auf der Startseite auf die Schaltfläche neben der zu löschenden Version und dann auf Delete (Löschen).
Klicken Sie zum Bestätigen auf Delete (Löschen).

Die ausgewählte Version wird gelöscht. Wenn Sie eine gesamte API löschen möchten, müssen Sie jede Version löschen.

Importieren des Versionsinhalts

Importieren Sie Inhalt aus einem bestehenden Vertrag in eine API-Version importieren, wobei der aktuelle Inhalt ersetzt oder zusammengeführt wird.

Sie sind ein Besitzer der API oder ein Bearbeiter der API-Version.

Aktualisieren Sie mithilfe dieser Funktion eine Version aus einer externen Vertragsdatei, ohne eine neue Version zu erstellen. Der Versionsbezeichner wird während des Imports beibehalten.

Dies unterscheidet sich vom Vorgang zum Importieren einer Definition, bei dem eine neue API im API Designer erstellt wird.

Öffnen Sie Import version content (Versionsinhalt importieren) für die zu aktualisierende Version.
Sie können auf diese Aktion an den folgenden Orten zugreifen:
- Klicken Sie auf der Startseite auf die Menüschaltfläche neben der Version und klicken Sie auf Import version content (Versionsinhalt importieren).
- Wählen Sie auf der Startseite die Version aus, um den Detailbereich zu öffnen, und klicken Sie dann auf Import version content (Versionsinhalt importieren).
- Klicken Sie im Versionseditor auf Edit (Bearbeiten) > Import version content (Versionsinhalt importieren).
Wählen Sie ein Format und eine Quelle für den zu importierenden Vertrag aus.
Sie können den Import aus einer lokalen Datei, einer URL oder aus Text durchführen, den Sie direkt im Dialogfeld einfügen.
Wählen Sie unter Behavior (Verhalten) aus, wie der importierte Inhalt angewendet werden soll.
- Replace (Ersetzen): Überschreibt den gesamten aktuellen Inhalt mit dem importierten Vertrag. Der API-Name, der Versionsbezeichner und die Spezifikationsversion werden beibehalten.
- Merge (Zusammenführen): Kombiniert den importierten Inhalt mit dem vorhandenen Versionsinhalt. Der API-Name und der Versionsbezeichner werden beibehalten. Wenn ein importiertes Element denselben Namen wie ein vorhandenes Element aufweist, wird das importierte Element mit dem Suffix _merge umbenannt (wie z. B. User_merge). Doppelte Basis-URLs und Medientypen werden übersprungen.
Klicken Sie auf Import (Importieren).

Der Versionseditor wird mit dem aktualisierten Inhalt geöffnet.

Hat diese Seite Ihnen geholfen?

Wenn Sie ein Problem mit dieser Seite oder ihrem Inhalt feststellen, sei es ein Tippfehler, ein ausgelassener Schritt oder ein technischer Fehler, informieren Sie uns bitte!

Geben Sie hier Ihr Feedback ab