/api-definitions/{id}エンドポイントでGETメソッドを使って、Talend Cloud API DesignerからAPI定義をエクスポートします。
このリクエストを使ったユースケースは、Talend Cloud API Designerの例をご覧ください。
始める前に
- Talend Cloud API DesignerにAPIが存在すること。
- 個人用のアクセストークンが生成されていること。詳細は、パーソナルアクセストークンを生成をご覧ください。
手順
-
Talend Cloud API Testerを開き、新しいリクエストを作成します。
-
デフォルトのGETメソッドを維持し、次のURIを正しいパラメーターと共に入力します。
https://apid.{region}.cloud.talend.com/api/v1/api-definitions/{api-id}
パラメーター |
説明 |
{region} |
使用するTalend Cloudアカウントのリージョン。値は次のようになります。
詳細は、Talend CloudのリージョンとURLをご覧ください。
|
{api-id} |
取得するAPIバージョンのID。取得するためには、Talend Cloud API DesignerでAPIを開き、に移動するか、/api-definitionsエンドポイントでGETメソッドを使ってAPI定義のリストをIDと共に取得します。 |
- オプション:
[QUERY PARAMETERS] (クエリーパラメーター)を展開して[Add query parameters] (クエリーパラメーターを追加)をクリックします。
次のパラメーターを使用できます。
パラメーター |
説明 |
format |
自分の定義のエクスポートで使う形式です。値は次のようになります。
- OpenApi3 (デフォルト値)
- Swagger20
- Swagger12
- Raml10
- Raml08
- OpenApi3Aws (AWS API Gatewayと互換性がある形式)
- Swagger20Azure (Azure API Managementと互換性がある形式)
|
talendExtensions |
エクスポートした定義にTalendの拡張機能や注釈を含めるかどうかを指定します。値としてtrueかfalseを指定します。デフォルト値はfalseです。 情報メモ注: Talendの拡張機能はAWS API GatewayやAzure API Managementとは互換性がありません。formatパラメーターにOpenApi3AWSまたはSwagger20Azureを入力した場合、このパラメーターは無視されます。
|
-
[Add hearder] (ヘッダーを追加)ボタンをクリックし、[name] (名前)フィールドに Authorizationと、そして[value] (値)フィールドにBearerに続けてスペースと自分のトークンを入力します。
情報メモヒント: Talend Cloud API Testerでは、自分のトークンをプライベート環境変数として追加し、式ビルダーを使ってリクエストで参照できます。詳細は、
環境の使用をご覧ください。
-
リクエストが設定されたら、[Send] (送信)をクリックします。
例
タスクの結果
Talend Cloud API Testerは、選択した形式のAPI定義が含まれているレスポンスを返します。ページ下部の
[Download] (ダウンロード)ボタンをクリックすれば保存できます。