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

Question

如何通过apiary的markdown来表明请求的某个特定 header 是可选的？

我的代码:

• 请求
  apiKey 可以在 header 中传递(注意“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 ，有MSON Parameters and Headers目前处于 RFC 阶段的功能；这将使您能够在 MSON 中描述 HTTP header 语法并将每个 HTTP header 标记为必需/可选(见下文)。

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

希望 MSON header 能够尽快落地。