クイック概要

細心の注意を払い、よく構造化されたZspec（ ZEST 仕様ファイル）は、可能性を最大限に活用するために最も重要です。 ZEST. この重要なファイルは、レストフルApiの開発、自動化、およびドキュメントの礎石として機能します。 包括的なブループリントを提供することで、apiライフサイクルのシームレスな実行と最適化を可能にします。Zspecの最も重要な要素を簡単に説明します。

リソース

のルート要素です。 ZEST 仕様 Xml ファイル。離散的かつ識別可能なデータ エンティティまたはオブジェクトを表します。 名前、製品、xsdバージョン、ファイルバージョンなど、zspecの基本的な詳細を網羅しています。 詳細については、確認できます 熱 意/ヘルプ/ zest -仕様ファイル/リソース/">ここ .

コンポーネント

のコンポーネント ZEST コンテキストはストレージユニットとして機能し、再利用可能な要素をカプセル化することで冗長性を最小限に抑えます。 参照してください 熱 意/ヘルプ/ zest -仕様ファイル/コンポーネント/">このドキュメント 要素の宣言と、Zspecの他の場所や製品全体での再利用をより深く掘り下げます。

お知らせ

これには、サポートチームの連絡先の詳細、リソースに関連付けられているライセンスの詳細、およびユーザーが可能な限りコンプライアンスに準拠した方法でリソースを消費するための利用規約が含まれています。 チェック 熱 意/ヘルプ/ zest -仕様ファイル/情報/紹介/">このページ この要素についてもっと知る。

リソース構成

この要素は、プライマリ構造、プライマリキー、およびそれらのタイプに関連するリソースの基本的な詳細で構成されます。 リソース構成の詳細については、 熱 意/ヘルプ/ zest -仕様ファイル/リソース構成/導入/">ここ .

サーバー

この要素では、ドメイン、Dc、url などのサーバーの詳細が設定されます。 url の特定の部分に異なる値を設定したり、要件に基づいてリソースを異なる環境に切り替えたりすることもできます。 参照してください 熱 意/ヘルプ/ zest -仕様ファイル/サーバー/紹介/">このドキュメント それについてもっと学ぶために。

Url

Url エンドポイントの詳細と、それに関連する可能な操作を保持します。 リソースに複数の url エンドポイントを持つことができ、各エンドポイントに複数の操作を持つことができます。 チェック 熱 意/ヘルプ/ zest -仕様ファイル/url/紹介/">ここ もっと見る

コンテンツ

コンテンツは、応答、要求、引数のタイプと本文の詳細を決定します。 さらに、Api ヘルプ ドキュメントでサンプルとしてレンダリングされるコンテンツの例を提供することもできます。 ヘッドオーバー 熱 意/ヘルプ/ zest -仕様ファイル/コンテンツ/紹介/">ここ この要素についてもっと知る。

構造

この要素は、Zspec内の1つまたは複数のプロパティのラッパーとして機能し、ソースコード内のpojoを表します。 マップ、コレクション、配列などの複雑なプロパティの場合、構造体はプロパティの子要素としても機能します。 参照してください 熱 意/ヘルプ/ zest -仕様ファイル/構造/紹介/">このページ この要素の詳細については、こちらをご覧ください。

不動産

このプロパティは、ZSPEC で設定された引数、応答、および要求本文の関数単位です。 json キーと値のペア、さらには値(コレクション)のみを記述します。 を見る 熱 意/ヘルプ/ zest -仕様ファイル/構造/プロパティ/導入/">ここ それについて詳細に。

データパス

データパスは、Jspecのjsonおよびxmlパスに似た式で、 / ヘルプ/データマネージャー/">データマネージャー . この式を使用して、変数を使用して現在の Api 呼び出しのデータを取得することもできます。 からデータパスを構築する方法を学びます。 熱 意/ヘルプ/ zest -仕様ファイル/データパス/">ここ .