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

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仕様内の情報に基づいてそれぞれの値が入力されます。

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

tRESTRequestを使用し、リポジトリーからAPIメタデータを参照してジョブを開くたびに、Talend 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定義で初期化されます。