不動産

Zspecの機能ユニットです。 引数/要求/応答のキーの詳細があります。

可能な場所

• 熱 意/ヘルプ/ zest -指定ファイル/構造/導入/">構造

子要素

• 熱 意/ヘルプ/ zest -仕様ファイル/非推奨/">非推奨 - 熱 意/ヘルプ/ zest -仕様ファイル/説明/">説明 - 熱 意/ヘルプ/ zest -仕様ファイル/構造/プロパティ/xmlフォーマット/">xmlフォーマット - 熱 意/ヘルプ/ zest -指定ファイル/ファイルメタ/導入/">ファイルメタ - 熱 意/ヘルプ/ zest -仕様ファイル/構造/プロパティ/順序構造/">順序構造 - 熱 意/ヘルプ/ zest -指定ファイル/構造/導入/">構造 または 熱 意/ヘルプ/ zest -仕様ファイル/構造グループ/導入/">構造グループ または 熱 意/ヘルプ/ zest -仕様ファイル/複合構造グループ/">複合構造グループ - 熱意 /ヘルプ/ -指 zest 定ファイル/構造/プロパティ/拡張プロパティ/">拡張プロパティ 繰り返し

属性

コンテンツタイプ

特定のコンテンツタイプ 熱 意/ヘルプ/ zest -仕様ファイル/構造/導入/"> 不動産のために作られた。「不動産」というものがあるとします。 旅行記 宛先リソースには、宛先と探索する場所に関する包括的な詳細が含まれています。 ブログのコンテンツは HTML 形式でのみ指定する必要があります。 以下は、HTMLコンテンツがキーで受信されるサンプルjsonです。たとえば、

{
 "destinations": [
 {
 "travelogue": " 
 Paris, often called the City of Love or the City of Light, is a captivating metropolis in France. 
 Known for its timeless art, enchanting architecture, and delectable cuisine, Paris is a destination like no other. 
 From the iconic Eiffel Tower to the world-class Louvre Museum, this city is a treasure trove of history and culture. 
 Wander through charming streets, enjoy croissants at a local café, or take a romantic Seine River cruise. 
 Paris is a place where history, art, and romance converge, making it a must-visit for every traveler. 
"
}
]
}

次に、 コンテンツタイプ コンテンツを Html 形式で提供するには、以下に示すように、このプロパティの属性を使用します。

<property name="travelogue" type="string" content-types="text/html" />

追加値

この属性を使用すると、プロパティがプロパティで提供される可能な値のリスト以外の余分な値を受け入れるかどうかを決定できます。 値 属性。たとえば、旅行リソースには次のプロパティがあります。

<property name="transport_medium" type="string" values="Roadways,Airways,Waterways" />

このプロパティに対して異なる動作を設定してみましょう。 追加値 属性。

許可する

上記のプロパティに追加の価値を許可したいと考えてください。

<property name="transport_medium" type="string" values="Roadways,Airways,Waterways" extra-value="allow" />

拒否

プロパティに追加の値を許可したくありません。

<property name="transport_medium" type="string" values="Roadways,Airways,Waterways" extra-value="deny" />

マップ デフォルト

プロパティのデフォルト値を宣言し、余分な値が提供されるたびにマッピングします。 したがって、次のように指定する必要があります。

<property name="transport_medium" type="string" values="Roadways,Airways,Waterways" extra-value="map-default" default-value="Roadways"/>

無効な値

無効な値 (プロパティを定義する属性を満たさない値) が提供されたときのプロパティの動作を定義するのに役立ちます。以下を取ってみましょう 熱 意/ヘルプ/ zest -仕様ファイル/構造/導入/"> トリップ リソースから、トリップ リソースに対して異なる値を設定します。 無効な値 理解しやすさのための属性。

<structure>
 <property name="accommodation_type" type="string" values="Hotel,Resort,Vacation Rental,Hostel" />
 </structure>

拒否

プロパティの値がデータ型または可能な値に違反した場合は、値を拒否します。

<property name="accommodation_type" type="string" values="Hotel,Resort,Vacation Rental,Hostel" invalid-value="deny" />

マップ デフォルト

プロパティに無効な値が指定されているときにデフォルト値をマッピングするには、可能な値のいずれかをデフォルト値として宣言し、この属性を次のように使用する必要があります。

<property name="accommodation_type" type="string" values="Hotel,Resort,Vacation Rental,Hostel" invalid-value="map-default" default-value="Hotel" />

長さ

ザ 長さ 属性は、プロパティの値を次のように制限します。 キャラクター コレクション、マップ、およびファイルを除くすべてのデータ型。 の場合 地図 、それはの観点から機能します。 キーと値のペアの数 その中で、そして コレクター 、それはの観点から動作します マップ プロパティの数 その中に。 について ファイル データ型の場合、長さ属性は ファイル数 アップロードできます。

文字列

トリップ リソースでは、文字列の最小長を 5 にし、最大長を 10 にします。 これは次のように書かれるべきです、

<property name="trip_name" type="string" length="5,10" />

宣言したい場合 最大長さのみ 文字列の場合は、次のように記述する必要があります。

<property name="trip_name" type="string" length="50" />

宣言したい場合 最小限の長さのみ 文字列の場合は、次のように記述する必要があります。

<property name="trip_name" type="string" length="5,-1" />

地図

私たちが使用したと想像してみてください 熱 意/ヘルプ/ zest -仕様ファイル/構造/余分プロパティ/"> 旅行リソースで、ユーザーが旅行の個人的な要件を説明するカスタムプロパティを追加できるようにします。 ただし、カスタム プロパティの数を 2 に制限します。たとえば、デフォルトのプロパティは 3 つのキーと値のパリに貢献し、さらに 2 つのカスタムキーと値のペアのみを受け入れます。 したがって、トリップ リソースのマップ プロパティは、合計 5 つのキーと値のペアを受け入れます。次に、旅行リソースのマッププロパティを次のように記述する必要があります。

<structure>
 <property type="map" length="5">
 <structure>
 <property name="trip_name" type="string" />
 <property name="travelers" type="collections">
 <structure>
 <property name="string" />
 </structure>
 </property>
 <property name="destination" type="string" />
 <extra-property name-regex="^custom-[a-z]+$" type="object" />
 </structure>
 </property>
 </structure>

コレクター

トリップ リソースのコレクション プロパティに、ユーザーが提供する値と同じ数の値を受け入れることができながら、最小 3 つの値を持つようにすると仮定します。 この要件を取得するには、次のように長さ属性を使用する必要があります。

<property name="adventure_activities" type="collections" length="3,-1">
 <structure>
 <property type="string" />
 </structure>
 </property>

ファイル

トラベラー リソースにファイル プロパティがあり、ユーザーがアップロードできるファイル数を制限するとします。 この場合、 長さ 次のような属性、

<property name="id_proofs" type="file" length="3">
 <file-meta size="500,1500" overall-size="6000" import-url="false" continue-on-error="true">
 <extension name="png" size="500,1000" length="2"/>
 <extension name="jpg" length="1"/>
 <file-name regex="^[^\"0-9]+$" length="5,10" />
 </file-meta>
 </property>

パス

パス属性は、別のリソースからデータを取得するのに役立ちます。 このデータは、指定されたプロパティの可能な値として使用されます。 提供されたデータパスは、リソースのデータを目的のキーに絞り込むのに役立ちます。 データパスの詳細については、 熱 意/ヘルプ/ zest -仕様ファイル/データパス/">ここ .

条件なし

旅行リソースでは、次のようなプロパティがあります。 目的地 可能な値は、宛先リソースで指定された宛先名です。 さて、旅行者の財産はここに示すように書かれなければなりません。

<property name="destination" type="string" path="destinations:$.destination_name" />

条件を使って

という不動産があることを考えてみてください。 宿泊施設 可能な値が宿泊施設リソースからの宿泊施設名である旅行リソース。 利用可能な客室がある宿泊施設でのみ可能な値をさらにフィルタリングしたいと考えています。このプロパティでは、データパスを次のように記述する必要があります。

<property name="accommodation" type="string" path="accommodations:$.{rooms=='Available'}.accommodation_name" />

この条件は宿泊施設の名前を取得します。 お部屋 不動産は「利用可能」です。 条件の構築の詳細については、 熱 意/ヘルプ/ zest -仕様ファイル/条件/">この ドキュメント。 —

に含める

デフォルトでは、プロパティは 5 つのカテゴリ (読み取り、作成、更新、削除、アクション) のリクエストとレスポンスの両方に含まれます。 プロパティを特定のカテゴリにのみ含める場合は、 リクエスト[ カテゴリ一覧 (Csv) ], 応答[ カテゴリ一覧 (Csv) ]. プロパティは、フォーマットに記載されていない残りのカテゴリに対して除外されます。すべてのカテゴリを含めるには、 アスタリスク(\ ) カテゴリのリストの代わりに、またはリクエスト/レスポンス形式を指定しないように選択できます。 たとえば、 リクエスト[\ ], 応答[作成、更新] そして 応答[作成、更新] つまり、プロパティがリクエストのすべてのカテゴリに含まれ、応答のカテゴリを作成、更新のみを作成する必要があります。 すべてのカテゴリを除外するには、 空の配列([]) あなたの条件に基づく要求/応答で。さて、私たちはと呼ばれる不動産を持っていることを考えてみましょう 旅行名 コンポーネントで 熱 意/ヘルプ/ zest -仕様ファイル/構造/導入/"> 旅行リソース

<property name="trip_budget" type="integer" />

このプロパティの構造は、5 つのカテゴリすべてでリクエストとレスポンスの両方に使用されます。 さまざまな要件を達成するためにこの属性をどのように使用できるかを見てみましょう。

両方の特定のカテゴリ

このキーを更新、削除、およびアクションのリクエスト本文に表示したくないとします。 応答本文では、読み取りとカテゴリの作成のためにキーを表示したくない。 したがって、キーが表示される対応するカテゴリのみを指定する必要があります。

<property name="trip_budget" type="integer" include-for="Request[read,create], Response[update,delete,action]" />

両方のすべてのカテゴリ

このキーを、5 つのカテゴリのリクエストとレスポンス本文に表示します。

<property name="trip_budget" type="integer" include-for="Request[ *], Response[* ]" />

— または —

<property name="trip_budget" type="integer" />

応答カテゴリでのみ

このキーは、読み取りカテゴリと作成カテゴリの応答本文にのみ表示します。 これは、任意のカテゴリのリクエスト本文に表示されるべきではありません。

<property name="trip_budget" type="integer" include-for="Request[], Response[read,create]" />

リクエストカテゴリでのみ

このキーをどのカテゴリの応答本文にも表示したくありません。 更新とアクションカテゴリのリクエスト本文にのみ表示されます。

<property name="trip_budget" type="integer" include-for="Request[update,action], Response[]" />

リクエスト内の特定のカテゴリと応答中のすべてのカテゴリ

このキーは、すべてのカテゴリの応答本文と、更新および作成カテゴリのリクエスト本文に表示されます。

<property name="trip_budget" type="integer" include-for="Request[update,create], Response[*]" />

— または —

<property name="trip_budget" type="integer" include-for="Request[update,create]" />

応答中の特定のカテゴリとリクエスト中のすべてのカテゴリ

このキーをすべてのカテゴリのリクエスト本文と、更新および作成カテゴリの応答本文に含める必要があります。

<property name="trip_budget" type="integer" include-for="Request[*], Response[update,create]" />

— または —

<property name="trip_budget" type="integer" include-for="Response[update,create]" />

必須のために

この属性は、リソースのリクエスト/レスポンスにおけるプロパティの外観を決定します。という不動産があることを考えてみてください。 旅行名 コンポーネントで 熱 意/ヘルプ/ zest -仕様ファイル/構造/導入/"> .

<property name="no_of_days" type="integer" />

このプロパティの構造は、惑星リソースの要求と応答の両方に使用されます。

リクエスト

プロパティをリクエスト本文にのみ表示したい場合。 これは、キーがオプションでリクエストに表示された古いレコードには影響しません。

<property name="no_of_days" type="integer" required-for="request" />

応答

キーを応答にのみ表示したい場合。 新しいレコードは、ユースケースに応じて、要求本文にキーを持つこともあれば、ないこともあります。新しいレコードのリクエスト本文にキーが指定されていない場合、応答としてこのキーが表示され、ヌル値またはデフォルト値(提供)になります。

<property name="no_of_days" type="integer" nullable-for="response" required-for="response" />

すべて

キーをリクエスト本文とレスポンス本文の両方に表示します。

<property name="no_of_days" type="integer" required-for="all" />

なし

キーをリクエスト本文とレスポンス本文の両方に強制的に表示したくありません。 したがって、キーは値がある場合にのみ表示されます。

<property name="no_of_days" type="integer" type="string" required-for="none" />

<property name="no_of_days" type="integer" />

<structure>
 <property name="traveler_email" type="string" />
 </structure>

<property name="traveler_email" type="string" nullable-for="request" />

<property name="traveler_email" type="string" nullable-for="response" />

<property name="traveler_email" type="string" nullable-for="all" />

<property name="traveler_email" type="string" nullable-for="none" />

<structure>
 <property name="trip_name" type="string" />
 </structure>

<property name="trip_name" type="string" unique-for="request" />

<property name="trip_name" type="string" unique-for="response" />

<property name="trip_name" type="string" unique-for="all" />

<property name="trip_name" type="string" unique-for="none" />

<structure>
 <property name="destination" type="string" />
 </structure>

<property name="destination" type="string" emptiable-for="Request" />

<property name="destination" type="string" emptiable-for="Response" />

<property name="destination" type="string" emptiable-for="all" />

<property name="destination" type="string" emptiable-for="none" />

<request-body>
 <content>
 <encode type="application/json"/>
 <structure>
 <property name="transport_medium" type="string" values="Roadways,Airways,Waterways,Hybrid"/>
 <property name="hybrid_details" type="string" condition-for-request="REQUEST:$.body.transport_medium == 'Hybrid'"/>
 </structure>
 </content>
 </request-body>

<response>
 <content>
 <encode type="application/json"/>
 <structure>
 <property name="transport_medium" type="string" values="Roadways,Airways,Waterways,Hybrid"/>
 <property name="hybrid_details" type="string" condition-for-response="RESPONSE:$.body.transport_medium == 'Hybrid'"/>
 </structure>
 </content>
 </response>

<structure>
 <property name="transport_medium" type="string" values="Roadways,Airways,Waterways,Hybrid"/>
 <property name="hybrid_details" type="string" condition-for-all="$.body.transport_medium == 'Hybrid'"/>
 </structure>

<property name="end_time" type="datetime" format="yyyy-MM-dd'T'HH:mm:ss+/-hh:mm" value-condition=">REQUEST:$.body.start_time" />

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