Arbeiten mit mehreren Versionen

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

Behalten Sie eine bestehende API-Version im Produktionsmodus bei und nehmen Sie umfassende und grundlegende Änderungen in einer neuen Version vor.
Profitieren Sie von einer umfassenden Übersicht und Kontrolle über veröffentlichte Versionen.
Profitieren Sie bei der Durchführung von Änderungen an einer API von größerer Flexibilität.

Bei der Erstellung einer neuen Version einer API wird der gesamte Inhalt in die neue Version kopiert. Jede Version kann dann unabhängig geändert werden, ohne dass die anderen Versionen davon beeinflusst werden.

Auf der Homepage von Talend Cloud API Designer werden alle Ihre APIs sowie alle für Sie freigegebenen API-Versionen angezeigt.

Erstellen einer neuen API-Version

Erstellen Sie eine neue Version einer bestehenden API-Definition.

Vorbereitungen

Sie fungieren als API-Verantwortlicher oder Editor/Bearbeiter für mindestens eine Version der API.

Prozedur

Navigieren Sie auf der Homepage zu der API, für die Sie eine neue Version erstellen möchten.
Sie können die Liste bei Bedarf nach Namen oder Verantwortlichen filtern.
Klicken Sie auf die Schaltfläche neben der Version, die kopiert werden soll, und dann auf Create a new version from <version> (Neue Version ausgehend von <version> erstellen).
Geben Sie die neue Version in das Feld Version ein.
Klicken Sie auf Create (Erstellen).

Ergebnisse

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

Vorbereitungen

Sie sind der Verantwortliche der API.

Prozedur

Klicken Sie auf der Homepage auf die Schaltfläche neben der Version, die gelöscht werden soll, und anschließend auf Delete (Löschen).

InformationshinweisAnmerkung: Eine Version kann nicht gelöscht werden, wenn die zugehörige Dokumentation im API Portal (API-Portal) veröffentlicht wurde. In diesem Fall müssen Sie zunächst die Veröffentlichung aufheben bzw. die Version als nicht veröffentlicht kennzeichnen, bevor Sie sie löschen. Weitere Informationen finden Sie unter Managing your API documentation.
Klicken Sie zur Bestätigung auf Delete (Löschen).

Ergebnisse

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

Importieren von Versionsinhalten

Importieren Sie Inhalte aus einem vorhandenen Vertrag in eine API-Version und ersetzen Sie den aktuellen Inhalt bzw. führen Sie ihn zusammen.

Vorbereitungen

Sie fungieren als API-Verantwortlicher oder Editor der API-Version.

Warum und wann dieser Vorgang ausgeführt wird

Verwenden Sie diese Funktion, um eine Version über eine externe Vertragsdatei zu aktualisieren, ohne eine neue Version zu erstellen. Die Versionskennung wird während des Imports beibehalten.

Dies ist anders als beim Importieren einer Definition, wodurch eine neue API in Talend Cloud API Designer erstellt wird.

Prozedur

Öffnern Sie Import version content (Versionsinhalte importieren) für die Version, die Sie aktualisieren möchten.
Sie können von folgenden Stellen aus auf diese Aktion zugreifen:
- Klicken Sie auf der Homepage auf die Menü-Schaltfläche neben der Version und anschließend auf Import version content (Versionsinhalte importieren).
- Wählen Sie auf der Startseite die Version aus, die im Detailfenster geöffnet werden soll, und klicken Sie dann auf Import version content (Versionsionhalte importieren).
- Klicken Sie im Versions-Editor auf Edit (Bearbeiten) > Import version content (Versionsinhalte importieren).
Wählen Sie ein Format und eine Quelle für den zu importierenden Vertrag aus.
Sie können aus einer lokalen Datei oder einer URL importieren oder Text direkt in das Dialogfeld einfügen.
Wählen Sie unter Behaviour (Verhalten) aus, wie der importierte Inhalt angewendet werden soll.
- Replace (Ersetzen): überschreibt alle aktuellen Inhalte mit dem importierten Vertrag. Der Name, die Versionskennung und die Spezifikationsversion der API werden beibehalten.
- Merge (Zusammenführen): kombiniert die importierten Inhalte mit den vorhandenen Versionsinhalten. Der API-Name und die Versionskennung werden beibehalten. Wenn ein importiertes Element den gleichen Namen wie ein vorhandenes Element hat, wird das importierte Element mit einem Suffix _merge umbenannt (z. B. User_merge). Duplizierte Basis-URLs und Medientypen werden übersprungen.
Klicken Sie auf Import (Importieren).

Ergebnisse

Der Versions-Editor wird mit den angewendeten aktualisierten Inhalten 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