Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

Veröffentlichen einer API-Version in GitHub

Verknüpfen Sie Ihre API mit einem GitHub-Repository und übertragen Sie Ihre API-Definition in OAS/Swagger oder RAML.

Vorbereitungen

  • Sie verfügen über ein GitHub-Konto und ein Repository.
  • Ihr Browser wird von GitHub unterstützt (da Internet Explorer 11 von GitHub nicht mehr unterstützt wird, wird von Talend Cloud API Designer für IE11 keine Unterstützung für diese Funktion geboten).

Prozedur

  1. Wenn Ihr GitHub-Konto noch nicht mit Ihrem Talend Cloud API Designer-Konto verknüpft ist, gehen Sie zu den API Designer settings (API Designer-Einstellungen).
  2. Klicken Sie auf Link your GitHub account (Ihr GitHub-Konto verknüpfen).
    Abschnitt GitHub account (GitHub-Konto)e in API Designer settings (API Designer-Einstellungen).
  3. Melden Sie sich in dem daraufhin geöffneten Fenster bei GitHub an und klicken Sie auf Authorize Talend (Talend autorisieren), um Talend Cloud API Designer den Zugriff auf Ihr GitHub-Konto zu ermöglichen.
    InformationshinweisWARNUNG: Wenn Sie Internet Explorer 11 verwenden, werden Sie zur Aktualisierung auf die neueste Version von Microsoft Edge, Google Chrome oder Firefox aufgefordert.

    Your GitHub account is now linked to your Talend Cloud API Designer account and you can start pushing your API definitions to GitHub.

  4. Öffnen Sie die API-Version, die Sie in GitHub übertragen möchten.
  5. Klicken Sie auf Link in der oberen rechten Ecke.
  6. Aktivieren Sie die Option im Abschnitt Edit GitHub settings (GitHub-Einstellungen bearbeiten) und bearbeiten Sie die folgenden Felder:
    • Owner (Verantwortlicher)
    • Repository
    • Branch
    • Path (Pfad)
    • Format
    In der Dropdown-Liste Format können Sie festlegen, dass Ihre Definition mit Talend-Erweiterungen oder in einem Kompatibilitätsmodus für API-Gateways exportiert werden soll.
    InformationshinweisAnmerkung: Wenn von Ihrer API mehrere Versionen vorhanden sind, kann jede Version über unterschiedliche GitHub-Einstellungen verfügen.
    Abschnitt Edit GitHub settings (GitHub-Einstellungen bearbeiten) der Ansicht API Settings (API-Einstellungen).
  7. Sobald Sie Ihre Einstellungen gespeichert haben, klicken Sie auf Push (Pushen).
    Rechts neben Push (Pushen) wird ein grüner Punkt angezeigt, wenn Ihr Projekt Änderungen enthält, die nicht in GitHub übertragen wurden.
    Screenshot des Projekts, wenn es Änderungen enthält, die nicht an GitHub übertragen wurden.
  8. Geben Sie eine Commit-Nachricht und nach Bedarf ein Tag ein und klicken Sie dann auf Push (Pushen).
    Tags müssen eindeutig sein und folgenden Regeln entsprechen:
    • Sie dürfen nur alphanumerische Zeichen sowie folgende Sonderzeichen enthalten: _, -, . und /.
    • Sie dürfen weder mit einem Sonderzeichen beginnen noch mit einem Sonderzeichen enden.
    • Sie dürfen nicht folgende Zeichenmuster enthalten: .., // und /..

Ergebnisse

Die ausgewählte Version Ihrer API-Definition wird in Ihr Repository übertragen. Der Name der generierten Datei enthält den Namen der API und die Version.

Sie können auf View on GitHub (In GitHub anzeigen) klicken, um das ausgewählte Repository zu öffnen.

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!