Abrufen der API-Dokumentation über die Management-API

Verwenden Sie die Management-API von Talend Cloud API Designer, um Ihre API-Definition im Inhaltsformat des API-Portals „API Portal Content“ abzurufen und in Ihrem Repository hinzuzufügen.

1. Verwenden Sie den folgenden Befehl mit den relevanten Parametern, um die API im richtigen Format abzurufen:

   curl -X GET -H "Authorization:Bearer {userToken}" https://apid.{region}.cloud.talend.com/api/v1/api-definitions/{api-id}?format=ApiPortalContent

   Parameter	Wert
   {userToken}	Über Talend Cloud generiertes Token.
   {region}	Region für Ihr Talend Cloud-Konto. Mögliche Werte: us-west (USA Westen) us (USA) eu (Europa) ap (Asien-Pazifik) au (Australien) Weitere Informationen finden Sie unter Zugriff auf Talend Cloud-Anwendungen.
   {api-id}	ID der abzurufenden API-Version. Sie finden die ID, wenn Sie Ihre API in Talend Cloud API Designer öffnen und Settings (Einstellungen) > MANAGEMENT API (MANAGEMENT-API) aufrufen oder die GET-Methode am /api-definitions-Endpunkt vewenden. Dadurch wird eine Liste der API-Definitionen mit den zugehörigen IDs aufgerufen.

2. Kopieren Sie die Antwort auf den Befehl.
3. Öffnen Sie im Repository Ihres API-Portals den Ordner apis.
4. Erstellen Sie in apis einen Ordner mit dem Namen der API und erstellen Sie in diesem Ordner einen neuen Ordner mit dem Namen der Version.

   Example

   Wenn Sie über eine API namens „Contacts“ (Kontakte) der API-Version 4.0.0 verfügen, sollte die Ordnerstruktur folgendermaßen aussehen: /apis/contacts-api/4.0.0/.
5. Erstellen Sie eine Datei namens index.md im Versionsordner und fügen Sie die Antwort auf den Befehl in die Datei ein.

   Example

   

6. Optional: Wenn Sie ebenfalls API-Definitionen bereitstellen möchten, die von Ihren Benutzern heruntergeladen werden können, verwenden Sie denselben Befehl mit dem Format OpenApi3 oder Swagger20. Speichern Sie dann den Antwortinhalt als openapi30.json oder swagger20.json im gleichen Ordner wie die Dokumentation.
7. Übergeben Sie Ihre Änderungen.