Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

Konfigurieren Ihres Portals mit einem anderen Git-Anbieter

Wenn Sie die API-Portal-Funktion mit einem anderen Git-Anbieter als GitHub verwenden möchten, können Sie den Starter-Satz sowie Ihre API-Dokumentation herunterladen und sie in Ihr Repository übertragen.

Herunterladen des Starter-Satzes für das API-Portal

Laden Sie den Starter-Satz für das API-Portal von Talend Cloud herunter, um es mit Ihrem bevorzugten Git-Anbieter zu verwenden. Weitere Informationen zum Inhalt der Vorlage finden Sie unter Repository architecture.

Prozedur

  1. Melden Sie sich bei Talend Cloud an.
  2. Klicken Sie auf das Benutzermenü in der oberen rechten Ecke der Seite und anschließend auf Downloads. Scrollen Sie dann zur Kachel API Portal (API-Portal).
  3. Wählen Sie API Portal Starter Kit (zip) (Starter-Satz für das API-Portal (zip)) aus, klicken Sie auf Download (Herunterladen) und speichern Sie die Datei.
    Kachel API Portal auf der Seite Downloads.
  4. Entzippen Sie die Datei in dem Repository, das Sie als Quelle für Ihr Portal verwenden möchten.
  5. Übergeben Sie Ihre Änderungen.

Ergebnisse

Ihr Repository wird konfiguriert, d. h. Sie können jetzt Ihre API-Dokumentation hinzufügen und Ihr Portal anpassen. Weitere Informationen finden Sie unter Customizing your portal.

Herunterladen der API-Dokumentation

Laden Sie Ihre API-Dokumentation und API-Definitionen herunter, um sie auf Ihrem Portal zu veröffentlichen.

Prozedur

  1. Öffnen Sie Talend Cloud API Designer und rufen Sie die Registerkarte API Portal (API-Portal) auf.
  2. Klicken Sie auf Configure the API Portal (API-Portal konfigurieren).
  3. Klicken Sie auf Select API Documentation to publish (API-Dokumentation zur Veröffentlichung auswählen).
    API Portal-Konfigurationsseite.
  4. Klicken Sie auf der Registerkarte API Portal (API-Portal) auf die Schaltfläche Download (Herunterladen), um die Dokumentation für eine API herunterzuladen, und speichern Sie die Datei.
    Die heruntergeladene ZIP-Datei enthält standardmäßig folgende Elemente:
    • Eine index.md-Datei mit der API-Dokumentation, die auf dem Portal veröffentlicht werden soll.
    • Eine openapi30.json- und eine swagger20.json-Datei mit der API-Definition in OAS 3.0 bzw. Swagger 2.0. Diese Dateien können von Benutzern vom Portal heruntergeladen werden.

    Sie können die herunterzuladenden API-Definitionen in den Settings (Einstellungen) auswählen. Weitere Informationen finden Sie unter Publishing downloadable API definitions.

    Registerkarte API Portal.
  5. Entzippen Sie die Datei in Ihrem Repository im Ordner apis.
    Der apis-Ordner muss einen Ordner für jede API sowie einen Unterordner für jede API-Version enthalten.
  6. Übergeben Sie Ihre Änderungen.

Ergebnisse

Sie haben eine API per Push in Ihr Repository übertragen und können sie jetzt in Ihrem Portal implementieren.

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!