编写Swagger（openAPI）规范：securityDefinitions

Question

我正在尝试在Swagger页面上实现HTTP Basic Auth。

docs for securityDefinitions举个例子：

type: http
scheme: basic

然而，当我将它添加到我的YAML文件中时：

securityDefinitions:
  type: http
  scheme: basic

我收到错误：

我做错了什么？

Answer 1

type: http
scheme: basic

是OpenAPI 3.0语法（您链接的规范是OpenAPI 3.0）。

但您使用的是OpenAPI 2.0，因此您需要使用：

securityDefinitions:
  BasicAuth:
    type: basic

security:
  - BasicAuth: []

这是OpenAPI 2.0规范：
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#securitySchemeObject

这是2.0的基本身份验证指南：
https://swagger.io/docs/specification/2-0/authentication/basic-authentication/