Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

Konfigurieren Ihres Portals mit GitHub

Talend Cloud API Designer ermöglicht Ihnen die automatische Konfiguration eines GitHub-Repository, wobei Ihre API-Portal-Konfiguration und API-Dokumentation übernommen werden. Wenn Sie einen anderen Source Control-Anbieter verwenden möchten, finden Sie weitere Informationen unter Configuring your portal with another Git provider.

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. Stellen Sie eine Verbindung zu Ihrem GitHub-Repository her:
    • Wenn Sie Talend Cloud API Designer noch kein GitHub-Konto zugeordnet haben, klicken Sie auf Link your GitHub account (Ihr GitHub-Konto verknüpfen) und genehmigen Sie Talend den Zugriff auf Ihre Repositories.
    • Wurde Ihr Konto bereits verknüpft, dann klicken Sie auf Select a GitHub repository (GitHub-Repository auswählen).
    API Portal-Konfigurationsseite.
  4. Wählen Sie das zu verwendende Repository aus:
    • Um ein neues Repository zu erstellen, wählen Sie Create a new GitHub repository (Neues GitHub-Repository erstellen) und dann den Verantwortlichen aus und geben Sie einen Namen ein.
    • Um ein bestehendes Repository zu verwenden, wählen Sie Use an existing GitHub repository (Vorhandenes GitHub-Repository verwenden), den Verantwortlichen, das Repository und den zu verwendenden Branch aus.
    Dialogfeld Select a GitHub repository (GitHub-Repository auswählen).
  5. Optional: Klicken Sie auf die Schaltfläche Enable GitHub Pages (GitHub Pages aktivieren) und weisen Sie die GitHub-Workflow-Berechtigung zu, wenn Ihr Portal automatisch auf GitHub Pages veröffentlicht werden soll.
    Diese Berechtigung ist für die automatische Konfiguration von GitHub-Aktionen für Ihr Repository erforderlich. Sie können GitHub Pages auch zu einem späteren Zeitpunkt über die API-Portal-Einstellungen bzw. manuell über Ihr Repository aktivieren. Weitere Informationen finden Sie unter Deploying your portal with GitHub Pages.
    InformationshinweisAnmerkung: Dadurch wird jede bereits vorhandene Konfiguration von GitHub Pages in Ihrem Repository überschrieben.
  6. Klicken Sie auf Select API Documentation to publish (API-Dokumentation zur Veröffentlichung auswählen).
    Die API-Portal-Vorlage wird in das ausgewählte Repository im ausgewählten Branch übertragen, wenn Sie ein bestehendes Repository verwendet haben, bzw. im Haupt-Branch main, wenn Sie ein neues Repository erstellt haben. Daraufhin wird eine Liste von APIs angezeigt, die veröffentlicht werden können.
  7. Klicken Sie auf die Schaltfläche Publish (Veröffentlichen) neben der API, die Sie veröffentlichen möchten.
    Screenshot einer Liste nicht veröffentlichter APIs.

Ergebnisse

Das Repository Ihres API-Portals wird konfiguriert und Ihre erste API veröffentlicht. Sie können Ihr Portal jetzt anpassen und implementieren.

In diesem Abschnitt

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