apiary.io - 如何在 apiary 的 Markdown 中显示可选标题？

Question

如何通过 apiary 的降价来指示请求的一个特定标头是可选的？

我的代码：

• 请求
  apiKey 可以在标头中传递（注意“apiKey”
  的驼峰式） Content-Encoding: gzip 是可选的，只有当你 gzip 实体时

  • 标头

    apiKey: `42452-eofefo-4534535` (optional)
    Content-Type: application/json
    Content-Encoding: gzip (optional)
    

以上可以吗？

Answer 1

截至 2016 年 1 月，这是不可能的。

另一方面——如果你去API Blueprint Roadmap，有目前处于 RFC 阶段的MSON 参数和标头功能；这将使您能够以MSON语法描述 HTTP 标头，并将每个 HTTP 标头标记为必需/可选（见下文）。

+ Response 200 (application/json)
    + Headers
        + Date (Date, optional) - Date at which the message was originated

希望 MSON 标头尽快落地。