サンプルによる設計を使用したパラメーターデータ型の推測
サンプルによる設計は、RESTデータソースからのレスポンスに基づいて定義セット(XMLスキーマ)を自動的に推測する機能です。RESTデータソースを作成したら、データソースエディターを開き、[Design By Example(サンプルによる設計)]ボタンを使用してパラメーターのデータ型を推測し、必要に応じてデータ型を編集できます。通常、サンプルによる設計は本文パラメーターのデータ型を推測するために使用されます。
サンプルによる設計機能にアクセスするには、次のようないくつかの方法があります。
データソースエディターを使用してサンプルによって定義セットを作成する
新しいRESTデータソースを作成する場合も、既存のデータソースを編集する場合も、エディターを操作してサンプルによる設計機能にアクセスする方法は同じです。
データソースエディターからサンプルによって定義セットを作成するには
1.RESTデータソースに定義されているすべての入力パラメーターがREST操作要件に従って定義されていることを確認します。
定義セットはRESTサービスのレスポンスから作成されるため、正確なレスポンスのために正しい入力が重要です。
3.データソースについて、以下を確認します。
- 操作が一覧表示されます。
- 操作にHTTP動詞が割り当てられています。
- [Operation URL(操作URL)]に変数が含まれている場合は、中括弧({})で囲まれています。URLパラメーターが解析され、画面の[URL Parameters(URLパラメーター)]部分に一覧表示されている必要があります。
- 保存およびイントロスペクト済みです。
4.RESTデータソースエディターを開きます(まだ開いていない場合)。
5.[Configuration(構成)]タブを選択します。
6.タブの[Connection Information(接続情報)]部分までスクロールして、[Basic(基本)]タブを選択します。
7.画面の[Operations(操作)]部分までスクロールします。
8.画面の[Header/Body Parameters(ヘッダー/本文パラメーター)]部分で、[Design By Example(サンプルによる設計)]をクリックします。
このデータソースに対してXMLスキーマファイルが以前に作成または指定されている場合は、メッセージがポップアップ表示されます。[OK]をクリックして続行し、そのファイルを新しい情報で上書きします。
9.操作に入力パラメーターが含まれている場合は、[Input Values for <op_variable>(<op_variable>の入力値)]ウィンドウで[URL Parameters(URLパラメーター)]の値を入力します。入力する値は、URLパラメーターのデータ型と一致している必要があります。
[Add Definition Type(定義タイプの追加)]ダイアログが表示されます。
10.画面のツリーペインで、サンプル定義セットに移動します。TDVはサンプル定義セットを使用して、REST操作のJSONまたはXMLレスポンスから新しい定義セットを自動的に作成します。作成された定義セットは編集可能です。
通常、サンプルによる設計ロジックは、本文パラメーター型(通常はOUTパラメーター)のメタデータを提案するために使用されます。
11.右側のペインで、[Show(表示)]フィールドの定義セットから[Element(要素)]または[Type(種類)]を選択し、画面の他の部分にあるリストでいずれかの値を選択します。
選択すると、そのサンプル定義への完全なStudioツリーパスが[Type(種類)]フィールドに表示されます。
12.[OK]をクリックします。
[Header/Body Parameters(ヘッダー/本文パラメーター)]セクションに、名前のない新しい行が表示されます。ただし、デフォルトの場所(本文)、データ型、および入出力方向(IN)は指定されています。StudioのRESTデータソースに、スキーマの提案に使用された操作TDVの名前が付いた新しい定義セットリソースが作成されます。
13.[Param Name(パラメーター名)]をダブルクリックしてパラメーターの名前を入力します。
14.他の列にリストされている値が設計と一致していることを確認します。
15.JSON形式のデータの場合は、[XML <-> JSON]の選択を行います。結果セットをXMLに変換するには、チェックボックスをオンにします。JSON形式を保持するには、チェックボックスをオフにします。
16.編集したデータソースを保存します。
Webサービス操作エディターを使用してサンプルによって定義セットを作成する
Webサービス操作エディターからサンプルによって定義セットを作成するには
1.RESTデータソースに定義されているすべての入力パラメーターがREST操作要件に従って定義されていることを確認します。
定義セットはRESTサービスのレスポンスから作成されるため、リクエストの入力が正しい場合にのみ正確なレスポンスが返されます。
3.データソースについて、以下を確認します。
- 操作が一覧表示されます。
- 操作にHTTP動詞が割り当てられています。
- [Operation URL(操作URL)]に変数が含まれている場合は中括弧({})で囲まれており、URLパラメーターが解析されて画面の[URL Parameters(URLパラメーター)]部分に一覧表示されています。
- 保存およびイントロスペクト済みです。
4.StudioのリソースツリーでRESTデータソースノードを展開します。
5.操作を選択してエディターを開きます。
6.[Design By Example(サンプルによる設計)]をクリックします。
このデータソースに対してXMLスキーマファイルが以前に作成または指定されている場合は、メッセージがポップアップ表示されます。[OK]をクリックして続行し、そのファイルを新しい情報で上書きします。
7.操作に入力パラメーターが含まれている場合は、[Input Values for <op_variable>(<op_variable>の入力値)]ウィンドウで[URL Parameters(URLパラメーター)]の値を入力します。入力する値は、URLパラメーターのデータ型と一致している必要があります。
[Add Definition Type(定義タイプの追加)]ダイアログが表示されます。
8.画面のツリーペインで、サンプル定義セットに移動します。TDVはサンプル定義セットを使用して、REST操作に対するJSONまたはXMLレスポンスから新しい定義セットを自動的に作成します。作成された定義セットは編集可能です。
通常、サンプルによる設計ロジックは、本文パラメーター型(通常はOUTパラメーター)のメタデータを提案するために使用されます。
9.右側のペインで、[Show(表示)]フィールドの定義セットから[Element(要素)]または[Type(種類)]を選択し、画面の他の部分にあるリストでいずれかの値を選択します。
選択すると、そのサンプル定義への完全なStudioツリーパスが[Type(種類)]フィールドに表示されます。
10.[OK]をクリックします。
[Header/Body Parameters(ヘッダー/本文パラメーター)]セクションに、名前のない新しい行が表示されます。ただし、デフォルトの場所(本文)、データ型、および入出力方向(IN)は指定されています。StudioのRESTデータソースに、スキーマの提案に使用された操作TDVの名前が付いた新しい定義セットリソースが作成されます。
11.[Param Name(パラメーター名)]をダブルクリックしてパラメーターの名前を入力します。
12.他の列にリストされている値が設計と一致していることを確認します。
13.変更を保存します。