例

リクエスト/レスポンスボディの例があります。これらの例は、Api ヘルプドキュメントの右側のペインにサンプルを提供するために使用されます。

可能な場所

熱意/ヘルプ/ zest -仕様ファイル/コンポーネント/">コンポーネント - 熱意/ヘルプ/ zest -仕様ファイル/コンテンツ/紹介/">コンテンツ

子要素

熱意/ヘルプ/ zest -仕様ファイル/説明/">説明 - 価値必須

この要素で要求または応答の実際の例を示します。

属性

お名前	タイプ	説明
お名前必須	文字列	リソースのサンプル要求/応答の名前。

注:

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

例

ヘルプドキュメントに追加する旅行リソースの応答のサンプルを取得したいと想像してみてください。したがって、ここに示すようにサンプルを例に追加する必要があります。

copy

         
<example name="Sample response of GET trips">
 <description> This is the core data of our trips resource. </description>
 <value>
 {
 "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
 }
 ]
 }
 </value>
 </example>

    

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

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit