Swagger如何访问Ocelot中带权限验证的API

先亮源代码：https://github.com/axzxs2001/Asp.NetCoreExperiment/tree/master/Asp.NetCoreExperiment/SwaggerDemo

这篇博文不是对asp.net core中使用Swagger作介绍，因为社区博客作了详细说明。

今天主要说一下Swagger在Ocelot网关权限验证模式下的访问，以及Swagger请求应答的数据格式。

首先创建四个项目：

SwaggerOcelot：asp.net core web api类型，api网关项目

SwaggerAuthorize：asp.net core web api类型，用户验证项目

SwaggerAPI01：asp.net core web api类型，api 1项目

SWaggerAPI02：asp.net core web api类型，api 2项目

首先在四个项目中添加基于Jwt的Toekn认证，参见https://www.cnblogs.com/axzxs2001/p/9250588.html

再在四个项目Nuget中引入Swashbuckle.AspNetCore，我的Demo中用的是2.5.0，再分别配置Swagger

 SwaggerAuthorize  Starup.cs配置

public void ConfigureServices(IServiceCollection services)
{
    services.AddTokenJwtAuthorize();
    services.AddMvc()
            .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
    services.AddSwaggerGen(options =>
    {
        options.SwaggerDoc("SwaggerAuthorize", new Info { Title = "Authorize", Version = "v1", Contact = new Contact { Email = "285130205@qq.com", Name = "Authorize", Url = "http://0.0.0.0" }, Description = "Authorize项目" });
        var basePath = PlatformServices.Default.Application.ApplicationBasePath;
        var xmlPath = Path.Combine(basePath, "SwaggerAuthorize.xml");
        options.IncludeXmlComments(xmlPath);
    });
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
 
    app.UseMvc()
        .UseSwagger(options =>
        {
            options.RouteTemplate = "{documentName}/swagger.json";
        })
        .UseSwaggerUI(options =>
        {
            options.SwaggerEndpoint("/SwaggerAuthorize/swagger.json", "Authorize");
        });
}

SwaggerAPI01，SwaggerAPI02类似，Starup.cs配置，其中让Swagger支付Token验证，就是要在这部分添加Swagger配置

public void ConfigureServices(IServiceCollection services)
{
    services.AddApiJwtAuthorize((context) =>
    {
        return true;
    });
 
    services.AddSwaggerGen(options =>
    {
        options.SwaggerDoc("SwaggerAPI01", new Info { Title = "API01", Version = "v1", Contact = new Contact { Email = "285130205@qq.com", Name = "API01", Url = "http://0.0.0.0" }, Description = "API01项目" });
        var basePath = PlatformServices.Default.Application.ApplicationBasePath;
        var xmlPath = Path.Combine(basePath, "SwaggerAPI01.xml");
        options.IncludeXmlComments(xmlPath);
 
        //这里是给Swagger添加验证的部分
        options.AddSecurityDefinition("Bearer", new ApiKeyScheme { In = "header", Description = "请输入带有Bearer的Token", Name = "Authorization", Type = "apiKey" });
        options.AddSecurityRequirement(new Dictionary<string, IEnumerable<string>> {
            {
                "Bearer",
                Enumerable.Empty<string>()
            }
        });
    });
    services
        .AddMvc()
        .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
}
 
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseMvc()
        .UseSwagger(options =>
        {
            options.RouteTemplate = "{documentName}/swagger.json";
        })
        .UseSwaggerUI(options =>
        {
            options.SwaggerEndpoint("/SwaggerAPI01/swagger.json", "API01");
        });
}

SwaggerOcelot，Starup.cs配置

public void ConfigureServices(IServiceCollection services)
{
    services.AddOcelotJwtAuthorize();
    //注入Ocelot
    services.AddOcelot(Configuration);
    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
 
    services.AddSwaggerGen(options =>
    {
        options.SwaggerDoc("ApiGateway", new Info { Title = "网关服务", Version = "v1", Contact = new Contact { Email = "285130205@qq.com", Name = "SwaggerOcelot", Url = "http://10.10.10.10" }, Description = "网关平台" });
    });
}
 
public async void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
 
    var apis = new Dictionary<string, string>(
        new KeyValuePair<string, string>[] {
            KeyValuePair.Create("SwaggerAuthorize", "Authorize"),
            KeyValuePair.Create("SwaggerAPI01", "API01"),
            KeyValuePair.Create("SwaggerAPI02", "API02")
        });
 
    app.UseMvc()
       .UseSwagger()
       .UseSwaggerUI(options =>
       {
           apis.Keys.ToList().ForEach(key =>
           {
               options.SwaggerEndpoint($"/{key}/swagger.json", $"{apis[key]} -【{key}】");
           });
           options.DocumentTitle = "Swagger测试平台";
       });
    await app.UseOcelot();
}

接下来，为Swagger访问Web API项目，添加请求返回格式，默认状况下，Swagger是支持Json的，下来添加支持XML格式

第一步，添加支持XML格式

services.AddMvc()
                  .AddXmlSerializerFormatters() //设置支持XML格式输入输出
                  .AddJsonOptions(op => op.SerializerSettings.ContractResolver = new DefaultContractResolver())//大小写不转换
                  .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

第二步，在对应的Action添加ProducesResponseType特性，为转换作支持

[HttpGet("{id}")]
[ProducesResponseType(typeof(API01Model), 200)]
public ActionResult<API01Model> Get(int id)
{
    return new API01Model { ID = 1, IsSure = true, Price = 2.3m, Describe = "test1" };
}

运行效果：

先看登录

再看api访问