管理APIによるAPIドキュメンテーションの取得

Talend Cloud API Designer管理APIを使用してAPI Portalコンテンツの形式でAPI定義を取得し、リポジトリーに追加します。

1. 次のコマンドおよび関連するパラメーターを使用して正しい形式のAPIを取得します。

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

   パラメーター	値
   {userToken}	Talend Cloudから生成されたトークン。
   {region}	使用するTalend Cloudアカウントのリージョン。値は次のようになります。 us-west us eu ap au 詳細は、Talend Cloudのアプリケーションにアクセスをご覧ください。
   {api-id}	取得するAPIバージョンのID。取得するためには、Talend Cloud API DesignerでAPIを開き、[Settings] (設定) > [MANAGEMENT API] (管理API)に移動するか、/api-definitionsエンドポイントでGETメソッドを使ってAPI定義のリストをIDと共に取得します。

2. レスポンスをコマンドにコピーします。
3. API Portalリポジトリーでapisフォルダーを開きます。
4. apis内にAPIの名前でフォルダーを作成し、そのフォルダー内にバージョン名で新しいフォルダーを作成します。

   例

   APIがContacts APIという名前でバージョン4.0.0なら、フォルダー構造は次のようになります: /apis/contacts-api/4.0.0/。
5. index.mdという名前のファイルをバージョンフォルダー内に作成し、コマンドに対するレスポンスをそこに貼り付けます。

   例

   

6. オプション: 自身のユーザーがダウンロードできるAPI定義も提供する場合は、形式がOpenApi3またはSwagger20の同じコマンドを使用し、レスポンスのコンテンツをopenapi30.jsonまたはswagger20.jsonとしてドキュメンテーションと同じフォルダーに保存します。
7. 変更をコミットします。