サンプルの使用 - Cloud

Talend Cloud API Designerユーザーガイド

EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend API Designer
task
ジョブデザインと開発 > Designing APIs

API全体のサンプルフィールドにデータを追加します。

Talend Cloud API Designerでは、APIのさまざまなエレメントのサンプル値を追加できます。サンプルを定義すると、モックにAPI呼び出しを行う時に使用されます。

次のサンプルでは、サンプルを使用してデータ型が作成されています。

このデータ型は、オペレーションのレスポンスボディとして使用されます。

Talend Cloud API Testerでオペレーションをテストすると、レスポンスとしてサンプルが返されます。

APIのさまざまな部分でサンプルを定義したり、モックを呼び出した時に他のものをオーバーライドするものもあります。ここでは、データ型のサンプルを使用していますが、オペレーションのレスポンスのサンプルを定義することもできます。

Talend Cloud API Testerでオペレーションをテストする場合、オペレーションで提供されているサンプルは、データ型で定義されているものよりも優先して使用されます。

データ型では、オブジェクト全体のサンプルを定義できます。両方を使用する場合は、モックをテストする時に、オブジェクト全体に使用されるサンプルが返されます。

外部サンプルはサポートされていません。