APIモックによるレスポンス生成 - Cloud

Talend Cloud API Designerユーザーガイド

EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend API Designer
task
ジョブデザインと開発 > Designing APIs
APIモックを有効にすると、すぐに使用できるようになります。

APIモックは、受信したコールに対して実際にありそうな応答を返します。レスポンスボディを生成する場合、モックではユーザーが指定したデータに対して、サンプルフィールド、デフォルト値、列挙型フィールドを検索して優先順位が設定されます。サンプルが見つかった場合は使用されますが、見つからなかった場合は、呼び出されるオペレーションによって返されるデータ型に基づいてJSONのサンプルが生成されます。

サンプルとして、以下に示す会社のデータ型定義を考えてみます。ユーザーが指定したサンプルは含まれていません。

モックがアクティブ化されると、次に示すTalend Cloud API Testerを使用して、/company/{companyId}リソースへのGETコールによって、データ型の構造に基づいて自動的に生成されたJSONレスポンスが返されます。

モックでは、カスタムレスポンスヘッダーの値を生成し(例、x-my-custom-header)、配列を識別して適切なサンプルを作成し(例、tagsプロパティ)、ネスティング構造を識別して値を生成する(例、addressプロパティ)など、多くの興味深いことが行われます。

Talend Cloud API Designerモックでは、コンテンツのネゴシエーションがサポートされているため、リクエストヘッダーを使用して、いくつかのオプションの中でどのボディを返すかを選択でき(それぞれ独自の例が用意されている可能性があります) 、モックによって返されるサンプルを変更できます。

注: APIモックを呼び出す時に、レスポンスヘッダー名の大文字と小文字が変更されることがあります。HTTPヘッダー名は大文字と小文字を区別しないため、この変更によって破損されるものはありません。