python - 未描述Flasgger标头参数
问题描述
我尝试使用 flasgger 为项目实现 swagger 文档。当我描述正文字段时 - 它工作正常,但是当我尝试描述标题字段时,flasgger 不会在网络上显示参数的描述。
flasgger 的 .yml 文件示例。
description: Client side interaction with server
consumes:
- "application/json"
parameters:
- in: header
name: headers_params
required: true
schema:
id: endpoint_header
required:
- session_token
properties:
session_token:
type: string
description: session token
- in: body
name: body_params
required: true
schema:
id: endpoint_body
required:
- parameter1
- parameter2
properties:
parameter1:
type: string
description: The parameter1 description
parameter2:
type: string
description: The parameter2 description
responses:
500:
description: The error on the server side
200:
description: Access token for user intercation
而且,这是我在网上看到的: 在此处输入图片描述
我应该遵循什么结构的 .yml 文件来获取标头中描述的会话令牌以及正文参数?
解决方案
看起来您使用的是 OpenAPI 2.0 语法。在 OAS2 中,头参数描述如下:
- in: header
name: session_token # <---- HTTP header name
required: true
type: string
description: session token
或者,可以将与身份验证相关的标头(例如会话令牌)描述为安全方案,例如API 密钥。
swagger: '2.0'
...
securityDefinitions:
session_token:
type: apiKey
in: header
name: session_token # <---- HTTP header name
# Add the "security" section either on the root level (if all endpoints
# are secured with this token), or inside individual GET/POST/etc. operations
security:
- session_token: []
推荐阅读
- python - OSX 上的 Emacs 在 python 模式下打破了 Ma 和 Me
- javascript - 无法在 vuex 中传递参数 id
- java - IntelliJ:在非模块化应用程序中的模块路径上放置一些依赖项
- node.js - 试图从 express 的 url 路径中获取用户名
- python - Seaborn:将 seaborn 从 0.9.0 升级到 0.11.0 后无法添加色调
- java - Android studio 游戏速度不同的设备
- javascript - 如何使用javascript在给定单词的输出中打印字典单词
- apache-spark - Databricks“使用创建表”选项记录在哪里
- algorithm - 给定两个未排序的数组,找出 A[i] > X 和 B[i] > Y 的对数
- python - 将多个路径作为命令行参数传递的最佳实践,以说明带有空格的路径