apiblueprint - 将资源模型重用为数组

Question

我正在记录一个 API，我有 2 个非常相似的响应。

其中之一是调用/resource/{id}。此响应返回一个资源模型。

另一个调用是/resource/search{?name,category}，它返回一个资源列表，所以我需要返回一个资源模型数组。

我找不到我是否可以这样做。在蓝图文档中有一些关于 Gists 的类似内容。但是有两种模型 Gist 和 Gist Collection。

我希望我解释了自己。

Answer 1

不幸的是，目前您无法从一个负载引用另一个负载。这样做的原因是负载(模型、请求或响应)对 API 蓝图解析器是不透明的(因此您不必转义其中的任何内容)。

有计划满足这一需求并在未来使蓝图更加干燥 - 请参阅 Embedded Assets和 Traits里程碑。