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

杰克·戈登(Jakejgordon)

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

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

我希望能够按照API蓝图标准在我的API文档中进行指定。但是,从我可以从API Blueprint标头部分的定义中看出,您只能指定文字值(例如Accept-Charset: utf-8),而不能指定标头应该是什么样的架构(例如X-Auth-Token (string))。

我觉得特质可能会帮助解决这个问题,但此刻我有点头疼。谁能告诉我如何指定对一个给定操作(或一组操作)的所有请求都需要X-Auth-Token标头?

帕万·库玛·桑卡拉(Pavan Kumar Sunkara)

您不能为标头定义架构是正确的。不幸的是,API蓝图尚不支持它。

在不支持这种情况之前,您可以使用标头的文字值,如下所示:

+ Headers

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

API蓝图目前也不支持Traits恐怕您可能对阅读其他功能要求感到困惑。

本文收集自互联网,转载请注明来源。

如有侵权,请联系 [email protected] 删除。

编辑于
0

我来说两句

0 条评论
登录 后参与评论

相关文章

Router.all()中的“ x-auth-token”标头返回未定义

使用 Spring 的 MockMVC 测试 API 登录后找不到 x-auth-token 标头

在标头php中发送带有x-auth-token的请求

如何在NodeJS端点中访问Ember-Simple-Auth-Token授权者标头

Python请求:auth +自定义标头

如何在邮递员中输入x-auth标头?

如何在API蓝图中指定请求标头

带有axios的X-XSRF-TOKEN标头

通过标头而不是查询参数发送api_token

是否可以从API网关上的AWS Custom Auth添加HTTP标头?

Flutter 如何将 Auth 令牌从 Flutter 安全存储设置为 dio 标头?

ValidateAntiForgeryToken AngularJS。X-XSRF-TOKEN标头和XSRF-TOKEN Cookie设置但得到400

如何在 Swagger UI 中包含 X-XSRF-TOKEN 标头?

如何让 fastapi 使用 x-gitlab-token 标头进行身份验证

CORS预检通道中的CORS标头“ Access-Control-Allow-Headers”中缺少令牌“ x-auth”

具有auth标头的Office App Ajax,连接到启用了cors的安全Web api 2后端

如何使用 Alamofire 向每个请求添加 auth 标头,并在响应为 401 时执行某些操作?

如何在ember-simple-auth中的后续请求中将身份验证令牌添加为标头?

我如何使用 jwt.auth 中间件将令牌传递给不在正文中的标头:laravel 5.6

hapi-auth-bearer-token仅适用于查询字符串中的access_token,而不能作为标头

Swagger标头定义

Angular 6不会将X-XSRF-TOKEN标头添加到http请求

Access-Control-Allow-Headers不允许请求标头字段X-CSRF-TOKEN

使用 API_KEY 而不是 ACCESS_TOKEN 的 Google Drive 标头身份验证

根据临时凭证正确生成AWS auth标头

具有特殊字符的SoapUI Auth标头

auth标头的vue资源拦截器

http-auth-interceptor未正确设置标头

HeaderHttpSessionStrategy x-auth-token安全吗?