如何在养蜂场文档中指定 Header 属性答案

【问题标题】：How to specify Header attributes in apiary documentation如何在养蜂场文档中指定 Header 属性
【发布时间】：2014-06-11 12:54:09
【问题描述】：

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

现在我还想将 HTTP 标头中传递的值添加到我的文档中（例如分页、API 的版本号……）

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

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

【问题讨论】：

标签： rest apiary.io

【解决方案1】：

您现在可以使用Headers section。

【讨论】：

我在哪里写标题条目的文档/描述？文档没有提到它。谢谢！

【解决方案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

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

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

【讨论】：

感谢您的回复。是的，我可以这样做，但我认为没有办法区分养蜂场中预见的参数和标头值？这样我就有点滥用参数表了……
是的，目前还没有办法进行这种区分。计划为Parametric Headers Description，但尚未实施。