web-dev-qa-db-de.com

Einrichten von Swagger (ASP.NET Core) mithilfe der Autorisierungsheader (Bearer)

Ich habe eine Web-API (ASP.NET Core) und versuche, den Swagger anzupassen, um die Aufrufe von ihm aus zu tätigen. Die Aufrufe müssen den Authorization-Header enthalten, und ich verwende die Bearer-Authentifizierung. Die Aufrufe von Dritten Party-Apps wie Postman usw. gehen gut ..__ Aber ich habe das Problem mit dem Einrichten der Header für swagger (aus irgendeinem Grund erhalte ich die Header nicht). So sieht es jetzt aus:

  "Host": "localhost:50352",
  "basePath": "/" ,
  "schemes": [
    "http",
    "https"
  ],
 "securityDefinitions":  {
    "Bearer": {
      "name": "Authorization",
      "in": "header",
      "type": "apiKey",
      "description": "HTTP/HTTPS Bearer"
    }
  },
  "paths": { 
    "/v1/{subAccountId}/test1": {
      "post": {
        "tags": [
          "auth"
        ],
        "operationId": "op1",
        "consumes": ["application/json", "application/html"],
        "produces": ["application/json", "application/html"],
        "parameters": [
          {
            "name": "subAccountId",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "security":[{
          "Bearer": []
        }],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        },
        "deprecated": false
      }
    },
22
J.Doe

Zunächst können Sie das Swashbuckle.AspNetCore-Nuget-Paket zum automatischen Generieren Ihrer Swagger-Definition verwenden. (getestet am 2.3.0) 

Nachdem Sie das Paket installiert haben, richten Sie es in Startup.cs in der Methode ConfigureServices ein

        services.AddSwaggerGen(c => {
            c.SwaggerDoc("v1", new Info { Title = "You api title", Version = "v1" });
            c.AddSecurityDefinition("Bearer", new ApiKeyScheme { In = "header", Description = "Please enter JWT with Bearer into field", Name = "Authorization", Type = "apiKey" });
            c.AddSecurityRequirement(new Dictionary<string, IEnumerable<string>> {
                { "Bearer", Enumerable.Empty<string>() },
            });

        });

Dann können Sie die Schaltfläche Autorisieren oben rechts auf der Seite verwenden.

Zumindest können Sie versuchen, dieses Paket zu verwenden, um eine gültige Swagger-Definition zu generieren

76
Vadim K

Momentan verfügt Swagger über Funktionen zur Authentifizierung mit JWT-Token und kann Token automatisch in den Header einfügen, habe ich hier geantwortet.

2
Pavel K.