rest - 如何在养蜂场文档中指定 Header 属性

Question

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

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

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

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

Answer 1

您现在可以使用Headers 部分。

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

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

您将收到来自解析器的警告，但它应该按预期工作。