如何在养蜂场文档中指定标题属性

Question

从Apiary开始，我目前正在为我们的项目指定API。 我能够定义API的定义，并且定义参数非常有效。

现在我想将HTTP Headers中传递的值添加到我的文档中（例如分页，API的版本号，......）

在浏览文档时，我发现标题可以在有效负载块或请求块中加载，但我希望它们显示在文档中。

这是可能的，实现这一目标的最佳方式是什么？

Answer 1

您现在可以使用Headers section。

Answer 2

实际上，URL模板中不需要存在参数。

因此，你能做的就是拥有

+ Parameters
    + id (required, number, `1`) ... Numeric `id` of the Note to perform action with. Has example value.
    + X-My-Header (required, number, `5469`) ... My header does something

这将在你提到的表格中呈现。

您将从解析器发出警告，但它应该按预期工作。