Herunterladen der API-Dokumentation

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

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).

   

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.

   

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.