0

我有许多需要发送 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 标头？

4

1 回答 1

1

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

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

+ Headers

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

API Blueprint 目前也不支持任何Traits。恐怕您可能会因阅读其他功能请求而感到困惑。

于 2015-04-27T08:49:10.603 回答