schreiben Swagger (openAPI) specs: securityDefinitions

Question

Ich versuche, HTTP Basic Auth auf meiner Swagger-Seite zu implementieren.

die docs for securityDefinitions geben ein Beispiel:

type: http 
scheme: basic 

aber wenn ich es auf meine YAML-Datei wie folgt hinzu:

securityDefinitions: 
    type: http 
    scheme: basic 

Ich erhalte eine Fehlermeldung:

Was mache ich falsch?

Answer 1

type: http 
scheme: basic 

ist die OpenAPI 3.0-Syntax (die Spezifikation, mit der Sie verbunden sind, ist OpenAPI 3.0).

Aber Sie verwenden OpenAPI 2.0, so dass Sie verwenden müssen:

securityDefinitions: 
    BasicAuth: 
    type: basic 

security: 
    - BasicAuth: [] 

Hier ist die OpenAPI 2.0 Spec:
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#securitySchemeObject

Und hier ist die Basis-Auth Führer für 2.0:
https://swagger.io/docs/specification/2-0/authentication/basic-authentication/