ジョブおよびルートと共にRESTメタデータを使用する - Cloud

Talend Cloud API Services Platform Studio ユーザーガイド

Version
Cloud
Language
日本語 (日本)
EnrichDitaval
API Services Platform
Product
Talend Cloud
Module
Talend Studio
Content
ジョブデザインと開発

REST APIメタデータが作成されたら、tRESTRequestコンポーネントでジョブに、cRESTでルートに使用できます。

tRESTRequestコンポーネントの[Basic settings] (基本設定)ビューで、[Definition] (定義)リストから[Repository] (リポジトリー)を選択します。

[Definition] (定義)フィールドの横にある[...]をクリックして[Repository Content] (リポジトリーのコンテンツ)ウィザードを開くと、リポジトリー内に作成されたREST APIメタデータが表示されます。
tRESTRequestコンポーネントで使用するメタデータからAPI仕様を選択し、[OK]をクリックします。

APIをメタデータノードから新しく作成したジョブにドラッグ&ドロップするという別法もあります。このオペレーションで、設定済みの新しいtRESTRequestコンポーネントが作成されます。

[REST Endpoint] (REST エンドポイント)フィールド、[REST API Mapping] (REST APIマッピング)テーブル、および[Documentation] (ドキュメンテーション)タブに、関連するパラメーターがすべて自動的に入力されます。これらのプロパティは必要に応じてアップデートできます。

[REST Endpoint] (エンドポイント)フィールドには、スキーム、ホスト、ポートなしでURLが入力されます。たとえばソースURLがhttp://myhost:8090/v1であれば、"/v1"のみがエンドポイント用に保持されます。

[REST API Mapping] (REST APIマッピング)テーブルで、[HTTP Verb][URI Pattern] (URIパターン)[Consumes] (コンシューム)[Produces] (プロデュース)に、API仕様内の情報に基づいてそれぞれの値が入力されます。

[Output Flow](出力フロー)カラムには、インポート中に以下のルールが適用されます:
  • 仕様にOperationIDが存在する場合は、この値が[Output Flow] (出力フロー)カラムに使用されます。存在しない場合は、仕様内のサマリーフィールドが120文字までの制限付きで使用されます。空白はアンダースコアに置換されます。
  • 仕様にオペレーションIDもサマリーフィールドも存在しないか、空白以外のサポートされていない文字が含まれている場合、[Output Flow] (出力フロー)カラムは空のままとなり、手動で入力する必要があります。
tRESTRequestの場合のみ、スキーマを[Output Flow] (出力フロー)の一部としてインポートする時に、以下のルールが適用されます:
  • OAS 2プリミティブタイプとTalendスキーマタイプ(整数、文字列、その他)の間の静的マッピング
  • 以下のパラメータータイプがサポートされており、スキーマの[Comment] (コメント)フィールドに設定されます。
    • コメント値に対するパスパラメーター: path
    • コメント値に対するクエリーパラメーター: query
    • コメント値へのヘッダーパラメーター: header
  • 以下のパラメータータイプは、インポートの一部として[Comment] (コメント)フィールドに対してサポートされていませんが、サービスデザインで必要になった場合に後で手動で追加できます。
    • フォームパラメーター
    • マトリクスパラメーター
    • Multipart
  • 仕様にパラメーターのデフォルト値が含まれている場合、これらのパラメーターのデフォルト値(ヘッダー、クエリー、パス)はスキーマの[Default] (デフォルト)カラム内に設定されます。
  • オブジェクト、配列、日付、時刻、および日時タイプのデータは、インポート中に文字列タイプのカラムに設定されます。これらのタイプは文字列にマッピングされるため、デフォルト値をインポートの一部として転送する処理はサポートされていません。
  • Null許容カラムはインポートされませんが、インポート中にデフォルト値に留まります。
注: Content-TypeまたはAccess-Keyのようなダッシュを使うヘッダーパラメーター名はサポートされていません。Talend Cloud API Designerまたはファイルからのダッシュを使うヘッダー名を含むREST APIメタデータをインポートする場合は、エラーが発生することがあります。

API Designer内、またはOAS 2.0仕様内で設定したセキュリティ情報は、tRESTRequestコンポーネントにインポートされません。ジョブ実装の一部としてTalend ESBによって提供されているセキュリティオプションから選択できます。

tRESTRequestを使用し、リポジトリーからAPIメタデータを参照してジョブを開くたびに、Studioはリンクされているメタデータコンテンツに従い、アップデートが必要かどうかをテストします。リポジトリーのAPIメタデータがアップデートされたら、tRESTRequestパラメーターのアップデートに対する確認を求める以下のプロンプトメッセージが表示されます。エンドポイントの既存の値を保つかどうかを選択できます。

tRESTRequestを使用し、削除済みのAPIメタデータを参照してジョブを開く時は、[Built-In] (組み込み)モードに切り替えるように求められます。

cRESTコンポーネントは、API定義を使用して、ジョブでtRESTRequestを初期化するのと同じ方法で、ルートデザインでメタデータから初期化できます。

データサービスとルートでコンポーネントtRESTRequestまたはcRESTのどちらかを使用していて、RESTコンポーネントの1つがAPI DesignerからRESTメタデータを使用している場合、コンテキストメニューから以下のアクションを使用できます。

  • [Open in API Designer] (API Designer内に開く): 外部のWebページを開き、API Designer内にAPI定義を表示する。
  • [Open API documentation] (APIドキュメンテーションを開く): 外部のWebページを開き、APIのドキュメンテーションを表示する。このアクションでは、APIドキュメンテーションがTalend Cloud API Designerで公開されている必要があります。そうでないとドキュメンテーションは利用できず、このメニューオプションで表示できません。
  • [Open in API Tester] (API Testerで開く): Talend Cloud API TesterをローカルのChromeブラウザーで開く。既に存在しているプロジェクトがない場合、テストプロジェクトは現在のAPI定義で初期化されます。