如何在养蜂场的降价中显示可选的 header?
How to show an optional header in markdown for apiary?
如何在 apiary 的 markdown 中指示一个特定的 header 请求是可选的?
我的代码:
请求
apiKey 可以在 header 中传递(注意 "apiKey" 的驼峰式)
Content-Encoding: gzip 是可选的,只有当你 gzip 实体时
Headers
apiKey: `42452-eofefo-4534535` (optional)
Content-Type: application/json
Content-Encoding: gzip (optional)
以上可以吗?
截至 2016 年 1 月,不可能。
另一方面,如果您转到 API Blueprint Roadmap, there's MSON Parameters and Headers feature which is currently in the RFC stage; this will enable you to describe HTTP Headers in the MSON 语法并将每个 HTTP Header 标记为 required/optional(见下文)。
+ Response 200 (application/json)
+ Headers
+ Date (Date, optional) - Date at which the message was originated
希望 MSON Header 早日着陆。
如何在 apiary 的 markdown 中指示一个特定的 header 请求是可选的?
我的代码:
请求
apiKey 可以在 header 中传递(注意 "apiKey" 的驼峰式)
Content-Encoding: gzip 是可选的,只有当你 gzip 实体时Headers
apiKey: `42452-eofefo-4534535` (optional) Content-Type: application/json Content-Encoding: gzip (optional)
以上可以吗?
截至 2016 年 1 月,不可能。
另一方面,如果您转到 API Blueprint Roadmap, there's MSON Parameters and Headers feature which is currently in the RFC stage; this will enable you to describe HTTP Headers in the MSON 语法并将每个 HTTP Header 标记为 required/optional(见下文)。
+ Response 200 (application/json)
+ Headers
+ Date (Date, optional) - Date at which the message was originated
希望 MSON Header 早日着陆。