コンテンツ

応答/要求/引数の本文に関する詳細を保持しています。

可能な場所

  • 熱 意/ヘルプ/ zest -仕様ファイル/コンポーネント/">コンポーネント - 熱 意/ヘルプ/ zest -仕様ファイル/url/操作/応答/">応答 - 熱 意/ヘルプ/ zest -指定ファイル/url/操作/要求ボディ/">要求ボディ - 熱 意/ヘルプ/ zest -仕様ファイル/引数/">引数

子要素

  • 熱意 /ヘルプ/ - zest 指定ファイル/コンテンツ/エンコード/">エンコード 必須 - 熱意 /ヘルプ/ - zest 指定ファイル/コンテンツ/エラー/">エラー - 熱 意/ヘルプ/ zest -仕様ファイル/リソース構成/パス構成/導入/">パス構成 - 熱意 /ヘルプ/ -仕 zest 様ファイル/構造/導入/">構造 または 熱 意/ヘルプ/ zest -仕様ファイル/構造グループ/導入/">構造グループ または 熱 意/ヘルプ/ zest -仕様ファイル/複合構造グループ/">複合構造グループ または 熱 意/ヘルプ/ zest -仕様ファイル/コンテンツ/ストリーム/">ストリーム 必須 - 熱意 /ヘルプ/ - zest 仕様ファイル/コンテンツ/例/">例 繰り返し

情報:
  • ザ 熱 意/ヘルプ/ zest -仕様ファイル/リソース構成/パス構成/導入/"> コンテンツレベルでは、 より高い優先度 を指定すると、異なるコンテンツに対して異なるデータ抽出パスを設定できます。 対照的に、パス設定は 熱 意/ヘルプ/ zest -仕様ファイル/リソース構成/導入/"> レベルは汎用であり、最も低い優先度を保持し、すべてのコンテンツに適用されます。- ザ 熱 意/ヘルプ/ zest -仕様ファイル/コンテンツ/エラー/"> コンテンツレベルで提供されるには、 より高い優先度 それはあなたがさまざまな条件を定義することを可能にするので 熱 意/ヘルプ/ zest -仕様ファイル/url/操作/応答/"> . しかし、エラーは、 熱 意/ヘルプ/ zest -仕様ファイル/url/操作/導入/"> レベルは、特定の操作の下にあるすべての応答に一般的であり、最も低い優先度が与えられます。

属性


お名前 タイプ 説明
お名前

必須

文字列 コンテンツの名前。
可視性 文字列 (列数) 要素を表示して使用できるユーザーを決定します。 可能な値は、 内部, プライベート, パブリック. デフォルト値はパブリックです。


注:

属性 お名前 コンテンツが子要素である場合にのみ必須です。 熱 意/ヘルプ/ zest -仕様ファイル/コンポーネント/"> .

サンプル

ストリーム

ファイルダウンロード用のレスポンスコンテンツを作成したいと想像してみてください。 以下はファイルの詳細です。

copy

Maximum allowed size of the file: 5000
 Maximum number of files that can be downloaded: 1
 File format: pdf

次に、旅行リソースのファイルのダウンロードコンテンツを次のように書き込みます。

copy

<response name="success" status="200">
 <content>
 <encode type="application/pdf" />
 <structure>
 <stream size="5000"/>
 </structure>
 </content>
 </response>

パス設定

トリップリソースでは、次の詳細を含むリクエスト本文を構築したいと考えています。

copy

request body:
 {
 "trips": [
 {
 "trip_name":"Spring Break - John Doe",
 "destination": "Bali",
 "start_time": "2023-11-13T17:30:00",
 "end_time": "2023-11-17T22:30:00",
 "no_of_days": 4
 }
 ]
 }
copy

  • The ’trips’ key will be used to extract the resource data.

  • Error condition: The status key of response should be “invalid”.

コンテンツを設定する方法は次のとおりです。 熱 意/ヘルプ/ zest -仕様ファイル/リソース構成/パス構成/導入/"> そして 熱 意/ヘルプ/ zest -仕様ファイル/コンテンツ/エラー/"> .

copy

<request-body name="request_payload">
 <content>
 <encode type="application/json" />
 <error condition="$.status == invalid"/>
 <path-config data-extraction-path="$.trips"/>
 <structure name="data">
 <property name="trips" type ="collections">
 <structure>
 <property name="trip_name" type="string"/>
 <property name="trip_id" type="long_string"/>
 <property name="destination" type="string"/>
 <property name="start_time" type="datetime"/>
 <property name="end_time" type="datetime"/>
 <property name="no_of_days" type="string"/>
 </structure>
 </property>
 </structure>
 <example>
 <value>
 {
 "trips": [
 {
 "trip_name":"Spring Break - John Doe",
 "trip_id":"5545974000000087501",
 "destination": "Bali",
 "start_time": "2023-11-13T17:30:00",
 "end_time": "2023-11-17T22:30:00",
 "no_of_days": 4
 },
 {
 "trip_name":"christmas Break - Diana Williams",
 "trip_id":"5545974000000087555",
 "destination": "London",
 "start_time": "2023-12-20T21:30:00",
 "end_time": "2023-12-28T09:30:00",
 "no_of_days": 7
 }
 ]
 }
 </value>
 </example>
 </content>
 </request-body>

構造グループ

3 つのエラー構造が同じ Http ステータス コードを持つレスポンス用のコンテンツを構築することを検討してください。 したがって、構造グループを使用してそれらを一緒にクラブする必要があります。この3つの構造をすでに宣言しています。 熱 意/ヘルプ/ zest -仕様ファイル/コンポーネント/"> .

  • 無効なリクエスト方法

  • 無効なデータ

  • 二重データ

copy

<components>
 <structure name="errorpattern" ref-name="error_pattern">
 <property type="map">
 <structure name="response" cases="InvalidValueInURLPath">
 <property name="code" type="string" values="INVALID_URL_PATTERN" />
 <property name="details" type="map" />
 <property name="message" type="string" values="Please check if the URL trying to access is a correct one" />
 <property name="status" type="string" values="error" />
 </structure>
 </property>
 </structure>
 <structure name="INVALID_DATA" extend="error_pattern" cases="InvalidValue">
 <property name="message" type="string" values="You have used an invalid page_token or the one generated by another user." />
 <property name="code" type="string" values="INVALID_DATA" />
 </structure>
 <structure name="INVALID_REQUEST_METHOD" extend="error_pattern">
 <property name="code" type="string" values="INVALID_REQUEST_METHOD" />
 <property name="message" type="string" values="The http request method type is not a valid one" />
 </structure>
 <structure name="DUPLICATE_DATA" extend="error_pattern" cases="Unique">
 <property name="code" type="string" values="DUPLICATE_DATA" />
 <property name="message" type="string" values="Failed to add since a record with same name already exists" />
 </structure>
 </components>

次に、この要件の内容を次のように記述します。

copy

<response name="error" status="400">
 <content>
 <encode type="application/json" />
 <structure-group name="400errors" type="one-of">
 <structure-ref name="INVALID_REQUEST_METHOD"/>
 <structure-ref name="INVALID_DATA"/>
 <structure-ref name="DUPLICATE_DATA"/>
 </structure-group>
 </content>
 </response>

Last Updated 2026-02-06 15:55:45 +0530 IST