cRESTの標準プロパティ

[API definition] (API定義)

[...]をクリックしてOAS/Swagger 2.0ファイルに移動し、コンポーネントのエンドポイント、APIマッピングおよびドキュメンテーションをAPI定義から初期化します。

[Endpoint] (エンドポイント)

RESTサービスが提供されるサービスエンドポイントURL。"http://localhost:8088/services/customers"のように明示的なポート番号を指定するか、Talendのデフォルトポートを使い、"/services/customers"のように相対パスのみを指定します。

TalendのStudioマンスリーアップデートR2020-05以降をインストールしている場合は、コンテキスト変数を使ってエンドポイントを定義できます。Studioマンスリーアップデートの詳細は、管理者にお問い合わせください。

[Type] (タイプ)

RESTサービスを提供するために使うタイプを選択します。[Manual] (手動)またはresourceClassのいずれか。

[Manual] (手動): cRESTがサービスプロバイダーとして使われている場合は、REST APIマッピングをテーブルで手動で決定するか、コンポーネントがサービスコンシューマーとして使われている場合は、HTTPメソッドとその他のパラメーターを設定します。

resourceClass: RESTサービスとしてエクスポートするリソースクラスを提供するには、このタイプを選択します。

[REST API mapping] (REST APIマッピング)

このテーブルは、[Manual] (手動)サービスタイプが選択され、cRESTがサービスプロバイダーとして使われている場合に表示されます。

テーブルの下にある[+]をクリックして必要な数の行を追加し、HTTPリクエストを指定します。

[Output Flow] (出力フロー): 出力フローの名前を指定します。

HTTP Verb: HTTPメソッドをリスト内のGET、POST、PUT、DELETE、OPTIONS、HEADから選択します。

[URI pattern] (URIパターン): リソースを説明するREST URIをこのフィルターに入力します。

[Consumes] (コンシューム): HTTP VerbがPOSTまたはPUTの場合は、コンポーネントが使うコンシュームコンテンツの形式タイプを、[XML or JSON] (XMLまたはJSON)、XML、JSON、Form、Multipart、Anyから選択します。

[Produces] (プロデュース): HTTP VerbがGET、POST、PUT、またはDELETEの場合は、コンポーネントが使うプロデュースコンテンツの形式タイプを、[XML or JSON] (XMLまたはJSON)、XML、JSON、HTML、Anyから選択します。

[Bean class] (Beanクラス): HTTP VerbがPOSTまたはPUTでコンシュームコンテンツの形式が[XML or JSON] (XMLまたはJSON)、XML、またはJSONの場合は、Beanクラスを設定します。

[Resource Class] (リソースクラス)

このフィールドは、resourceClassサービスタイプを選択すると表示されます。RESTサービスとしてエクスポートするリソースクラスの名前を入力します。

[Operation] (操作)

このフィールドは、resourceClassサービスタイプを選択し、サービスコンシューマーとしてcRESTを使っている場合に表示されます。操作の名前を入力します。

[Relative Path] (相対パス)

このフィールドは、[Manual] (手動)サービスタイプを選択し、サービスコンシューマーとしてcRESTを使っている場合に表示されます。呼び出すRESTサーバーの相対パスを入力します。

[HTTP Method] (HTTPメソッド)

[Content Type] (コンテンツタイプ)

このオプションは、[Manual] (手動)サービスタイプを選択し、サービスコンシューマーとしてcRESTを使っている場合に表示されます。

サーバーエンドにアップロードするコンテンツのメディアタイプに応じて、[XML]、[JSON]、[FORM]のいずれかを選択します。このリストは、[HTTP Method] (HTTPメソッド)リストでPOSTまたはPUTを選択した場合にのみ表示されます。

[Accept Type] (許可タイプ)

このフィールドは、[Manual] (手動)サービスタイプを選択し、サービスコンシューマーとしてcRESTを使っている場合に表示されます。

クライアントエンドで、サーバーエンドからの受信を許可するレスポンスのメディアタイプを選択します。オプションには、[XML]、[JSON]、[ANY] (すべて)があります。[ANY] (すべて)を選択すると、すべてのタイプのレスポンスメールを受け入れ、文字列に変換します。このリストは、DELETEメソッドを選択した場合は表示されません。

[Response Class] (レスポンスクラス)

このフィールドは、[Manual] (手動)サービスタイプを選択し、サービスコンシューマーとしてcRESTを使っている場合に表示されます。レスポンスクラスの名前を入力します。

[Skip incoming data unmarshalling] (受信データのマーシャリング解除を省略)

[Use Service Locator] (サービスロケーターを使用)

Service Locatorを有効にするには、このチェックボックスをオンにします。サービスネームスペースとサービス名をそれぞれのフィールドに指定します。

[Enable the Service Activity Monitoring] (サービスアクティビティモニタリングを有効にする)

サービスアクティビティモニタリングを有効にするには、このチェックボックスをオンにします。

このオプションはランタイムでのみ使えます。Studioでルートを実行する場合は、このチェックボックスをオフにすることをお勧めします。オンにしていると、実行コンソールに警告が表示されます。

[Use Authentication] (認証を使用)

認証オプションを有効にするには、このチェックボックスをオンにします。認証タイプを以下から選択します。

• [HTTP Basic] (HTTPベーシック): HTTPヘッダーに標準フィールドを使ってWebリソースへのアクセス制御を強制する最も単純な手法です。
• [SAML Token (ESB runtime only)] (SAMLトークン (ESB Runtimeのみ)): IDプロバイダーとサービスプロバイダーの間で認証データを交換するための、XMLベースでオープン標準のデータ形式。
• [Open ID Connect] (ID接続を開く): OAuth2の拡張機能で、クライアントは認証サーバーによって実行される認証に基づいてエンドユーザーのIDを確認したり、エンドユーザーに関する基本的なプロファイル情報を相互運用可能なRESTに類似した方法で入手したりできます。詳細は、Talend Identity and Access ManagementおよびESBリソースと認証の管理をご覧ください。

cRESTコンポーネントがコンシューマーとして使われている場合は、必要に応じてユーザー名とパスワードをそれぞれのフィールドに入力します。パスワードを入力するには、パスワードフィールドの横にある[...]ボタンをクリックし、ポップアップダイアログボックスにパスワードを二重引用符の間に入力し、[OK] をクリックして設定を保存します。

[Use Authorization] (認証サービスを使用)

このオプションは、Talend Enterprise ESBソリューションをサブスクライブしている場合のみ利用可能です。[Use Authentication] (認証を使用)リストで[SAML Token (ESB runtime only)] (SAMLトークン(ESB Runtimeのみ))を選択すると表示されます。

cRESTコンポーネントをサービスプロバイダーとして使う場合は、このチェックボックスをオンにして認証を有効にします。

cRESTコンポーネントをサービスコンシューマーとして使う場合は、このチェックボックスをオンにして許可された呼び出しを有効にし、[Role] (ロール)フィールドにクライアントのロールを指定します。

[Use Business Correlation] (ビジネスコリレーションを使用)

このチェックボックスをオンにしてこのコンポーネントにコリレーションIDを作成します。

コリレーションIDは[Correlation Value] (コリレーション値)フィールドで指定できます。

[Log messages] (ログメッセージ)

ルートのメッセージ交換を記録するには、このチェックボックスをオンにします。

[Expose Swagger specification] (Swagger仕様の公開)

このオプションは、cRESTがサービスプロバイダーとして使われている場合に表示され、[Manual] (手動)サービスタイプが選択されている場合のみ利用できます。Swagger仕様を公開し、Swagger UIをRESTサービスに含める場合は、このチェックボックスをオンにします。人が読める形式のオンラインAPIドキュメンテーションと、基本的なテスト機能が提供されます。

ルートがStudioで実行されている場合、Swagger仕様はhttp://127.0.0.1:8090/ENDPOINT/swagger.jsonとhttp://127.0.0.1:8090/ENDPOINT/swagger.yamlで入手できます。Swagger UIは使用できません。

ジョブがTalend Runtimeで実行されている場合、Swagger仕様はhttp://127.0.0.1:8090/services/SERVICE_NAME/swagger.jsonとhttp://127.0.0.1:8090/services/SERVICE_NAME/swagger.yamlで入手できます。Swagger UIは、http://127.0.0.1:8040/services/ENDPOINT/api-docs?url=/services/ENDPOINT/swagger.jsonで入手できます。

ジョブがESB Microserviceとして実行されている場合、Swagger仕様はhttp://127.0.0.1:8065/services/ENDPOINT/swagger.jsonおよびhttp://127.0.0.1:8065/services/ENDPOINT/swagger.yamlで入手できます。Swagger UIはhttp://127.0.0.1:8065/services/ENDPOINT/api-docs?url=/services/ENDPOINT/swagger.jsonで入手できます。

ESB Microserviceへのルートをビルドする方法とMicroserviceを実行する方法は、Studio Talendユーザーガイドを参照してください。

[Include Documentation into Swagger Spec] (ドキュメンテーションをSwagger仕様に含める)

このオプションは、cRESTがサービスプロバイダーとして使われ、[Expose Swagger specification] (Swagger仕様の公開)チェックボックスがオンの場合に表示されます。このコンポーネントの[Documentation] (ドキュメンテーション)タブの[Comment] (コメント)フィールド内のコンテンツをSwagger仕様とSwagger UIページに追加するには、このオプションを選択します。

[Documentation] (ドキュメンテーション)タブについては、Studio Talendユーザーガイドを参照してください。

使用ルール

cRESTは、サービスプロバイダーとしてルートの開始コンポーネント、またはサービスコンシューマーとして中間または終了コンポーネントにできます。

制限事項

ライセンスの互換性の問題のため、このコンポーネントの使用に必要な1つ以上のJARが提供されていません。この特定のコンポーネントに不足しているJARをインストールするには、Component (コンポーネント)タブビューの[Install] (インストール)ボタンをクリックします。Studioの Integration パースペクティブの[Modules] (モジュール)タブでも、不足しているすべてのJARを簡単に見つけて追加できます。詳細は、外部モジュールのインストールをご覧ください。外部モジュールをインストールする方法は、Talend Help Center (https://help.talend.com)をご覧ください。