如何定义 API 蓝图 X-Auth-Token Header
How To Define API Blueprint X-Auth-Token Header
我有许多服务需要发送类似于以下内容的 X-Auth-Token header：
X-Auth-Token: 2e5db4a3-c80f-4cfe-ad35-7e781928f7a2
我希望能够按照 API 蓝图标准在我的 API 文档中指定这一点。但是，根据我从 API Blueprint headers section definition 可以看出的情况，您只能指定文字值（例如 Accept-Charset: utf-8），而不能指定 header 应该是什么样子的模式（例如 X-Auth-Token (string)).
我的印象是 Traits 可能有助于解决这个问题，但目前有点难以理解。谁能告诉我如何指定对给定操作（或一组操作）的所有请求都需要 X-Auth-Token header?
关于无法为 header 定义架构的说法是正确的。遗憾的是，API Blueprint 尚不支持它。
在支持类似内容之前，您可以使用 header 的字面值，如下所示：
+ Headers
X-Auth-Token: 2e5db4a3-c80f-4cfe-ad35-7e781928f7a2
API 蓝图目前也不支持任何 Traits。恐怕您在阅读其他功能请求时可能会感到困惑。
我有许多服务需要发送类似于以下内容的 X-Auth-Token header：
X-Auth-Token: 2e5db4a3-c80f-4cfe-ad35-7e781928f7a2
我希望能够按照 API 蓝图标准在我的 API 文档中指定这一点。但是，根据我从 API Blueprint headers section definition 可以看出的情况，您只能指定文字值（例如 Accept-Charset: utf-8），而不能指定 header 应该是什么样子的模式（例如 X-Auth-Token (string)).
我的印象是 Traits 可能有助于解决这个问题，但目前有点难以理解。谁能告诉我如何指定对给定操作（或一组操作）的所有请求都需要 X-Auth-Token header?
关于无法为 header 定义架构的说法是正确的。遗憾的是，API Blueprint 尚不支持它。
在支持类似内容之前，您可以使用 header 的字面值，如下所示：
+ Headers
X-Auth-Token: 2e5db4a3-c80f-4cfe-ad35-7e781928f7a2
API 蓝图目前也不支持任何 Traits。恐怕您在阅读其他功能请求时可能会感到困惑。