API定義を作成

/api-definitionsエンドポイントでPOSTメソッドを使って、API定義をTalend Cloud API Designerにインポートします。

1. Talend Cloud API Testerを開き、新しいリクエストを作成します。
2. [METHOD] (メソッド)ドロップダウンリストからPOSTを選択します。
3. 正しいリージョンパラメーターと共に次のURIを入力します。
   https://apid.{region}.cloud.talend.com/api/v1/api-definitions

   リージョンは次のいずれかとなります。

   • us-west
   • us
   • eu
   • ap
   • au

   詳細は、Talend Cloudのアプリケーションにアクセスをご覧ください。

4. オプション: [QUERY PARAMETERS] (クエリーパラメーター)を展開して[Add query parameters] (クエリーパラメーターを追加)をクリックします。
   次のパラメーターを使用できます。

   パラメーター	説明
   format	インポートしているAPI定義の形式です。値は次のようになります。 OpenApi3 (デフォルト値) Swagger20 Swagger12 Raml10 Raml08
   failOnWarnings	モデル変換時の最初の警告で処理を停止するかどうかを指定します。値としてtrueかfalseを指定します。デフォルト値はfalseです。
   mainFile	複数のファイルが含まれているAPI定義をZIPファイルでインポートしている場合は、メインの定義ファイル名を入力します。

5. [Add hearder] (ヘッダーを追加)ボタンをクリックし、[name] (名前)フィールドに Authorizationと、そして[value] (値)フィールドにBearerに続けてスペースと自分のトークンを入力します。
   情報メモヒント: Talend Cloud API Testerでは、自分のトークンをプライベート環境変数として追加し、式ビルダーを使ってリクエストで参照できます。詳細は、環境の使用をご覧ください。
6. オプション: Content-Typeヘッダーを編集します。
   Talend Cloud API Testerはデフォルトで、application/jsonという値を持つContent-TypeヘッダーをPOSTリクエストに追加します。定義をYAMLファイルかZIPファイルとしてインポートする場合は、この値をapplication/x-yamlまたはapplication/zipに変更します。
7. API定義を追加します。
   • [BODY] (ボディ)テキストボックスに定義を入力します。

     

   • リクエスト本文の上にある[text] (テキスト)ドロップダウンリストをクリックして[File] (ファイル)を選択した後、ファイルを参照するかドラッグ＆ドロップします。

     

8. リクエストが設定されたら、[Send] (送信)をクリックします。

タスクの結果

API定義がTalend Cloud API Designerに作成されます。返されたレスポンスにはそのIDとその他のメタデータ(作成者IDや作成日など)が含まれています。