如何定义 API 蓝图 X-Auth-Token 标头答案

【问题标题】：How To Define API Blueprint X-Auth-Token Header如何定义 API 蓝图 X-Auth-Token 标头
【发布时间】：2015-05-19 16:27:15
【问题描述】：

我有许多需要发送 X-Auth-Token 标头的服务，类似于以下内容：

X-Auth-Token: 2e5db4a3-c80f-4cfe-ad35-7e781928f7a2

我希望能够按照 API 蓝图标准在我的 API 文档中指定这一点。但是，据我从API Blueprint headers section definition 得知，您只能指定文字值（例如Accept-Charset: utf-8），而不是标头应该是什么样子的架构（例如X-Auth-Token (string)）。

我的印象是 Traits 可能有助于解决这个问题，但目前这有点超出我的想象。谁能告诉我如何指定对给定操作（或一组操作）的所有请求都需要 X-Auth-Token 标头？

【问题讨论】：

标签： api rest apiblueprint

【解决方案1】：

您无法为标头定义架构是对的。不幸的是，API Blueprint 还不支持它。

在支持类似的东西之前，您可以使用标题的文字值，如下所示：

+ Headers

    X-Auth-Token: 2e5db4a3-c80f-4cfe-ad35-7e781928f7a2

API 蓝图目前也不支持任何Traits。阅读其他功能请求时，您可能会感到困惑。

【讨论】：