我有许多服务要求发送类似于以下内容的X-Auth-Token标头:
X-Auth-Token: 2e5db4a3-c80f-4cfe-ad35-7e781928f7a2
我希望能够遵循API Blueprint标准在我的API文档中指定它。但是,从API Blueprint headers section definition我可以看出,你只能指定文字值(例如Accept-Charset: utf-8
)而不是标题应该是什么样的模式(例如X-Auth-Token (string)
之类的东西)
我觉得Traits可能会帮助解决这个问题,但此刻它有点过头了。任何人都可以告诉我如何指定对给定操作(或一组操作)的所有请求都需要X-Auth-Token标头吗?
答案 0 :(得分:2)
您无法为标头定义架构,这是对的。不幸的是,API Blueprint尚不支持它。
在支持类似内容之前,您可以使用标题的文字值,如下所示:
+ Headers
X-Auth-Token: 2e5db4a3-c80f-4cfe-ad35-7e781928f7a2
API蓝图目前也不支持任何Traits
。我担心您可能会因阅读其他功能请求而感到困惑。