web-dev-qa-db-ja.com

Authorizationヘッダー（ベアラー）を使用してSwagger（ASP.NET Core）をセットアップする

Web API（ASP.NET Core）があり、そこから呼び出しを行うためにswaggerを調整しようとしています。呼び出しにはAuthorizationヘッダーが含まれている必要があり、ベアラー認証を使用しています。 Postmanなどのサードパーティアプリからの呼び出しは正常に機能します。しかし、私はswaggerのヘッダーの設定に問題があります（何らかの理由でヘッダーを受け取りません）。これは、現在の様子です。

  "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
      }
    },
c#asp.net-coreswagger-ui
41
J.Doe

まず、Swashbuckle.AspNetCore nugetパッケージを使用して、スワガー定義を自動生成できます。 （2.3.0でテスト済み）

パッケージをインストールしたら、ConfigureServicesメソッドのStartup.csでセットアップします。

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

});

次に、ページの右上にある[認証]ボタンを使用できます。

少なくとも、このパッケージを使用して有効なswagger定義を生成しようとすることができます。

112
Vadim K

現在、SwaggerにはJWTトークンによる認証機能があり、トークンをヘッダーに自動的に追加できます。私は here と答えました。

3
Pavel K.