サンプルの使用 - Cloud

Talend Cloud API Designerユーザーガイド

Version
Cloud
Language
日本語
Product
Talend Cloud
Module
Talend API Designer
Content
ジョブデザインと開発 > Designing APIs
Last publication date
2024-03-13

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

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

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

JSONの例から生成されたCharacterデータ型のスクリーンショット。

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

Get a Star Wars character by IDというメソッドでは、Characterデータ型が返されます。

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

キャラクターを伴うレスポンスの例。ここでのキャラクターはLuke Skywalkerです。

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

レスポンスに新しい例が定義されます。ここでのキャラクターはLeia Organaです。

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

レスポンス例のキャラクターはLeia Organaです。

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

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