# API定義をエクスポート

/api-definitions/{id}エンドポイントでGETメソッドを使って、Talend Cloud API DesignerからAPI定義をエクスポートします。

このリクエストを使ったユースケースは、[Talend Cloud API Designerの例](https://help.qlik.com/talend/ja-JP/api-designer-user-guide/Cloud/api-designer-examples)をご覧ください。

## 始める前に

* Talend Cloud API DesignerにAPIが存在すること。
* 個人用のアクセストークンが生成されていること。詳細は、[パーソナルアクセストークンを生成](https://help.qlik.com/talend/r/ja-JP/Cloud/management-console-user-guide/cloud-access-token)をご覧ください。

## 手順

1. Talend Cloud API Testerを開き、新しいリクエストを作成します。
2. デフォルトのGETメソッドを維持し、次のURIを正しいパラメーターと共に入力します。

   https://apid.{region}.cloud.talend.com/api/v1/api-definitions/{api-id}
   | パラメーター | 説明 |
   | --- | --- |
   | {region} | 使用するTalend Cloudアカウントのリージョン。値は次のようになります。<br><br><ul> <li> <span>us-west</span> </li> <li> <span>us</span> </li> <li> <span>eu</span> </li> <li> <span>ap</span> </li> <li> <span>au</span> </li> </ul><br><br>詳細は、[Talend CloudのリージョンとURL](https://help.qlik.com/talend/r/ja-JP/Cloud/links-regions-urls)をご覧ください。 |
   | {api-id} | 取得するAPIバージョンのID。取得するためには、Talend Cloud API DesignerでAPIを開き、[Settings] (設定) &gt; [MANAGEMENT API] (管理API)に移動するか、/api-definitionsエンドポイントでGETメソッドを使ってAPI定義のリストをIDと共に取得します。 |
3. オプション: [QUERY PARAMETERS] (クエリーパラメーター)を展開して[Add query parameters] (クエリーパラメーターを追加)をクリックします。

   次のパラメーターを使用できます。
   | パラメーター | 説明 |
   | --- | --- |
   | format | 自分の定義のエクスポートで使う形式です。値は次のようになります。<br><br><ul> <li> <kbd>OpenApi3</kbd> (デフォルト値)</li> <li> <kbd>Swagger20</kbd> </li> <li> <kbd>Swagger12</kbd> </li> <li> <kbd>Raml10</kbd> </li> <li> <kbd>Raml08</kbd> </li> <li> <kbd>OpenApi3Aws</kbd> (AWS API Gatewayと互換性がある形式)</li> <li> <kbd>Swagger20Azure</kbd> (Azure API Managementと互換性がある形式)</li> </ul> |
   | talendExtensions | エクスポートした定義にTalendの拡張機能や注釈を含めるかどうかを指定します。値としてtrueかfalseを指定します。デフォルト値はfalseです。<br><br>情報メモ注: Talendの拡張機能はAWS API GatewayやAzure API Managementとは互換性がありません。formatパラメーターにOpenApi3AWSまたはSwagger20Azureを入力した場合、このパラメーターは無視されます。 |
4. [Add hearder] (ヘッダーを追加)ボタンをクリックし、[name] (名前)フィールドに Authorizationと、そして[value] (値)フィールドにBearerに続けてスペースと自分のトークンを入力します。

   情報メモヒント: Talend Cloud API Testerでは、自分のトークンをプライベート環境変数として追加し、式ビルダーを使ってリクエストで参照できます。詳細は、[環境の使用](https://help.qlik.com/talend/r/ja-JP/Cloud/api-tester-user-guide/using-environments)をご覧ください。
5. リクエストが設定されたら、[Send] (送信)をクリックします。
   ### 例

   ![Talend Cloud API Testerでリクエストが設定されている状態。](https://help.qlik.com/talend/ja-JP/api-user-guide/Resources/images/export_api_definition_1_configured_request.png)

## タスクの結果

Talend Cloud API Testerは、選択した形式のAPI定義が含まれているレスポンスを返します。ページ下部の[Download] (ダウンロード)ボタンをクリックすれば保存できます。 ![ページ右下にある\[Download\] (ダウンロード)ボタン。](https://help.qlik.com/talend/ja-JP/api-user-guide/Resources/images/export_response.png)