apiblueprint - リソース モデルを配列として再利用する

Question

私は API を文書化していますが、非常によく似た 2 つの応答があります。

それらの 1 つは呼び出し /resource/{id} です。この応答は、リソース モデルを返します。

もう 1 つの呼び出しは、リソースのリストを返す /resource/search{?name,category} であるため、リソース モデルの配列を返す必要があります。

これができるかどうかわかりません。ブループリントのドキュメントには、Gists について同様の記述があります。ただし、Gist と Gist Collection の 2 つのモデルがあります。

私は自分自身を説明したことを願っています。

Answer 1

残念ながら、現時点では、あるペイロードを別のペイロードから参照することはできません。これは、ペイロード (モデル、リクエスト、またはレスポンス) が API ブループリント パーサーに対して不透明であるためです (したがって、内部で何もエスケープする必要はありません)。

将来的には、このニーズに対応し、ブループリントをより DRY にする計画があります。埋め込みアセットと特性のマイルストーンを参照してください。