如何在由Swagger Codegen 3生成的Python API客户端中设置承载令牌。十、

Question

我已经通过使用在线Swagger Codigen为该API生成了一个Python客户端库https://generator.swagger.io/.该API使用承载身份验证：

openapi: 3.0.0
...

paths:
  /sandbox/register:
    post:
      ...
      security:
        - sso_auth: []
      ...

components:
  securitySchemes:
    sso_auth:
      type: http
      scheme: bearer

但是，生成的Python客户端中的配置类没有访问令牌字段。

使用生成的客户端库时，如何填充承载访问令牌？

codegenendpointPOST/gen/clients/{language}具有authorizationValue和securityDefinition参数——我是否需要以某种方式配置这些参数？

"authorizationValue": {
  "value": "string",
  "type": "string",
  "keyName": "string"
},
"securityDefinition": {
  "type": "string",
  "description": "string"
}

Answer 1

首先，由于您的API是OpenAPI 3.0，因此需要使用Swagger Codegen 3。x、 即。https://generator3.swagger.io或swagger-codegen-cli-3.0.11。jar。发电机在https://generator.swagger.io适用于OpenAPI 2.0（swagger:'2.0'）。

也就是说，Swagger Codegen 3的Python生成器中有一个bug。x、 它不会生成OpenAPI 3.0定义中的承载身份验证代码。请在https://github.com/swagger-api/swagger-codegen-generators/issues

[CNNVD]OpenAPI文件安全定义漏洞（CNNVD-200512-436）AuthizationValue和security定义的/gen/Client参数与OpenAPI文件中的安全定义无关。

作为一种解决方法，编辑OpenAPI YAML文件并替换此部件

  securitySchemes:
    sso_auth:
      type: http
      scheme: bearer

与：

  securitySchemes:
    sso_auth:
      type: apiKey
      in: header
      name: Authorization

然后根据修改后的API定义生成一个新的Python客户端。

现在，一旦您按照自述文件中的说明安装了客户端软件包。md，您应该能够按如下方式设置令牌：

import swagger_client
...

# Configure API key authorization: sso_auth
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_BEARER_TOKEN'
configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MarketApi(swagger_client.ApiClient(configuration))
...