如何在flassger(python swagger)中为auth发送通用标头

时间:2019-04-30 07:44:01

标签: python flask swagger swagger-ui

当前,我在Flassger中使用这种类型的文档字符串,效果很好:

"""End Point to create something
  ---
  parameters:
    - name: body
      in: body
      type: string
      required: true
    - name: token
      in: header
      description: an authorization header
      required: true
      type: string
  responses:
    200:
      description: Some description
  """

我可以这样从ui发送请求:

enter image description here

但是我需要在此页面上将token参数设为全局,以便用户只需填写一次即可。我需要做些什么才能做到这一点?

1 个答案:

答案 0 :(得分:0)

您需要做的就是在api定义中定义授权令牌。 尝试这样的事情:

  securityDefinitions:
  Token:
   type: apiKey
   name: Token
   in: header

然后将此代码放在您要使用令牌保护的端点中:

 security:
 -Token: []

在您的示例中:

  parameters:
  - name: body
   in: body
   type: string
   required: true
   security
   - Token:[]
   responses:
     200:
      description: Some description

如果要使用令牌保护所有端点,请执行以下操作:

securityDefinitions:
  Token:
   type: apiKey
   name: Token
   in: header
security
   - Token:[]