如何在基于令牌的身份验证的 ASP.Net WebAPI 2.0 中使用 Swagger

Question

我有一个基于令牌的身份验证的 ASP.Net WebApi，我想使用 swagger 为这个 RestApi 创建文档。

Api 目前只有两种方法，一种用于请求令牌，即http://localhost:4040/token ，另一种用于创建通知。 返回的不记名令牌的发送方式如下：

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 Notification 方法，但是我无法执行请求，因为我没有令牌并且我不知道如何在 swagger 中执行此操作。

Answer 1

我自己找到了解决方案。 如果有人面临同样的问题，我想分享它。 解决方案分为两步，第一步是请求令牌，下一步是将令牌添加到标头请求中。

所以第一步：

自定义前端以启用请求令牌的 post 请求：

添加一个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"
                        },
                    }
                }
            });
        }
    }

并在注册方法中的 SwaggerConfig 类中，添加此操作

c.DocumentFilter<AuthTokenOperation>();

到扩展方法：

GlobalConfiguration.Configuration.EnableSwagger

在请求头中添加授权令牌：

添加这个操作类：

/// <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"
                });
            }
        }
    }

并在注册方法中的 SwaggerConfig 类中，添加此操作

c.OperationFilter<AddAuthorizationHeaderParameterOperationFilter>();

到扩展方法：

GlobalConfiguration.Configuration.EnableSwagger

当然在Authoization字段中，需要添加：Bearer token_string

Answer 2

我只想在接受的答案中添加一些内容，即当 autorest 用于客户端生成时，接受的答案不完整，因为它错过了某些属性。

[致命]所有操作都需要OperationId。 请为'/authenticate'路径的'post'操作添加它。 例外：尝试为 REST API 添加客户端时，代码生成过程中出现错误 生成客户端代码并添加到项目失败 为失败添加 REST API 客户端

post = new Operation
            {
                operationId = "Auth_AccessToken",
                tags = new List<string> { "Auth" },
                produces = new List<string>
                {
                    "application/json",
                    "text/json",
                    "application/xml",
                    "text/xml"
                },
                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 = true,
                        @in = "formData"
                    },
                    new Parameter
                    {
                        type = "string",
                        name = "password",
                        required = true,
                        @in = "formData"
                    },
                    new Parameter
                    {
                        type = "string",
                        name = "client_id",
                        required = true,
                        @in = "formData"
                    },
                    new Parameter
                    {
                        type = "string",
                        name = "client_secret",
                        required = true,
                        @in = "formData"
                    }
                },
                responses = new Dictionary<string, Response>
                {
                    {"200", new Response{ description = "OK", schema = new Schema{ type = "object"} } }
                }
            }

您需要添加 operationId 和响应以使 autorest 正常工作。