Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

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.
Talend Cloud API Designer-Homepage.

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

  1. 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.
  2. Klicken Sie auf die Schaltfläche Menu (Menü) neben der Version, die kopiert werden soll, und dann auf Create a new version from <version> (Neue Version ausgehend von <version> erstellen).
    Ansicht der Movie catalog API mit erweitertem Menüsymbol für die Version 1.1.0.
  3. Geben Sie die neue Version in das Feld Version ein.
  4. Optional: Deaktivieren Sie das Kontrollkästchen Copy sharing settings (Freigabe-Einstellungen kopieren), um die Freigabe-Einstellungen zurückzusetzen.
    Wenn die Quellversion für andere Benutzer oder Gruppen freigegeben wurde, werden standardmäßig dieselben Einstellungen in die neue Version kopiert. Durch die Deaktivierung dieses Kontrollkästchens übernimmt die neue Version die Freigabe-Einstellungen auf API-Ebene. Weitere Informationen finden Sie unter Sharing a specific version of an API.
  5. Optional: Bearbeiten Sie die GitHub-Einstellungen.
    Wenn die Quellversion mit GitHub verknüpft ist, werden dieselben Einstellungen in die neue Version kopiert. Sie können den Branch und den Pfad ändern oder das Kontrollkästchen Copy GitHub settings (GitHub-Einstellungen kopieren) deaktivieren, um die GitHub-Integration für die neue Version zu deaktivieren. Anschließend können Sie sie wieder aktivieren und nach Bedarf konfigurieren. Weitere Informationen finden Sie unter Pushing an API version to GitHub.
  6. Klicken Sie auf Create (Erstellen).
    Dialogfeld Create a new version (Neue Version erstellen), in dem die neue Version anhand der Movie catalog API version 1.1.0 erstellt wird. Die neue Version ist 1.2.0, und die Optionen zum Kopieren, Teilen und die GitHub-Einstellungen sind ausgewählt. Die Version wird im Master-Branch erstellt.

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

  1. Klicken Sie auf der Homepage auf die Schaltfläche Menu (Menü) neben der Version, die gelöscht werden soll, und anschließend auf Delete version (Version 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.
  2. Klicken Sie auf Are you sure? (Sind Sie sicher?), um den Vorgang zu bestätigen.

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.

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!