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

Question

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

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

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

我找不到我能不能做到这一点。在蓝图文档中有关于 Gists 的类似内容。但是有两个模型 Gist 和 Gist Collection。

我希望我解释了我自己。

Answer 1

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

有计划解决这一需求并在未来使蓝图更加干燥 - 请参阅嵌入式资产和特征里程碑。