web-dev-qa-db-ja.com

トークンベースの認証でASP.Net Web API 2.0でSwaggerを使用する方法

トークンベースの認証を備えたASP.Net WebApiがあり、swaggerを使用してこのRestApiのドキュメントを作成したいと考えています。

現在のところ、APIには2つのメソッドしかありません。1つはトークンをリクエストするメソッドです。つまり、http://localhost:4040/tokenともう1つは通知を作成するためのものです。返された署名なしトークンは次のように送信されます。

using (var client = new HttpClient())
{
    // setup client
    client.BaseAddress = new Uri("http://localhost:4040");
    client.DefaultRequestHeaders.Accept.Clear();
    client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
    client.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

    var serializedNotification = new JavaScriptSerializer().Serialize(notification);
    var stringContent = new StringContent(serializedNotification, Encoding.UTF8, "application/json");

    var response = await client.PostAsync("api/Notification", stringContent);
    response.EnsureSuccessStatusCode();

    // return URI of the created resource.
    return response.Headers.Location;
 }

Swaggerではpost通知メソッドを表示できますが、トークンがなく、swaggerでそれを行う方法がわからないため、リクエストを実行できません。

c#asp.net-web-apiswaggerbearer-token
11
alaa_sayegh

私は自分で解決策を見つけました。誰かが同じ問題に直面している場合に備えて、それを共有したいと思います。解決策は2つのステップで構成され、最初のステップはトークンを要求することであり、次のステップはトークンをヘッダー要求に追加することです。

だから最初のステップ：

フロントエンドをカスタマイズして、トークンをリクエストするためのポストリクエストを有効にします。

enter image description here

AuthTokenOperationクラスを追加して、IDcoumentFilterインターフェースを継承し、Applyメソッドを実装できるようにします。

public class AuthTokenOperation : IDocumentFilter
    {
        /// <summary>
        /// Apply custom operation.
        /// </summary>
        /// <param name="swaggerDoc">The swagger document.</param>
        /// <param name="schemaRegistry">The schema registry.</param>
        /// <param name="apiExplorer">The api Explorer.</param>
        public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
        {
            swaggerDoc.paths.Add("/token", new PathItem
            {
                post = new Operation
                {
                    tags = new List<string> { "Auth"},
                    consumes = new List<string>
                    {
                        "application/x-www-form-urlencoded"
                    },
                    parameters = new List<Parameter>
                    {
                        new Parameter
                        {
                            type = "string",
                            name = "grant_type",
                            required = true,
                            @in = "formData"
                        },
                        new Parameter
                        {
                            type = "string",
                            name = "username",
                            required = false,
                            @in = "formData"
                        },
                        new Parameter
                        {
                            type = "string",
                            name = "password",
                            required = false,
                            @in = "formData"
                        },
                    }
                }
            });
        }
    }

そして、registerメソッドのSwaggerConfigクラスに、このアクションを追加します

c.DocumentFilter<AuthTokenOperation>();

拡張メソッドに：

GlobalConfiguration.Configuration.EnableSwagger

リクエストヘッダーに認証トークンを追加するには：

enter image description here

この操作クラスを追加します。

/// <summary>
    /// The class to add the authorization header.
    /// </summary>
    public class AddAuthorizationHeaderParameterOperationFilter : IOperationFilter
    {
        /// <summary>
        /// Applies the operation filter.
        /// </summary>
        /// <param name="operation"></param>
        /// <param name="schemaRegistry"></param>
        /// <param name="apiDescription"></param>
        public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
        {
            if (operation.parameters != null)
            {
                operation.parameters.Add(new Parameter
                {
                    name = "Authorization",
                    @in = "header",
                    description = "access token",
                    required = false,
                    type = "string"
                });
            }
        }
    }

そして、registerメソッドのSwaggerConfigクラスに、このアクションを追加します

c.OperationFilter<AddAuthorizationHeaderParameterOperationFilter>();

拡張メソッドに：

GlobalConfiguration.Configuration.EnableSwagger

もちろん、Authoizationフィールドで、次を追加する必要があります：Bearer token_string

31
alaa_sayegh