如何在带区域的 net core 3.1 Web 应用程序中配置 swagger？

Question

我正在我的 mvc web 应用程序（不是 webapi）中编写 web 服务端点（作为一个区域：'api'）。有没有人可以告诉我如何配置一个区域的 swagger？

services.AddSwaggerGen();

app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("api/swagger/v1/swagger.json", "MY API V1");
    c.RoutePrefix = "api";
});

Answer 1

首先，你可以写一个扩展的class来得到AreaName，像这样：

  public static class ApiDescriptionExtension
    {
        public static List<string> GetAreaName(this ApiDescription description)
        {
            string areaName = description.ActionDescriptor.RouteValues["Area"];
            List<string> areaList = new List<string>();
            areaList.Add(areaName);
            if (!string.IsNullOrEmpty(areaName))
            {
                description.RelativePath = $"{description.RelativePath}";
            }
            return areaList;
        }
    }

然后在您的StartUp（添加此代码：c.TagActionsBy(apiDesc => apiDesc.GetAreaName());）：

  services.AddSwaggerGen(c =>
        {
            c.SwaggerDoc("v1", new OpenApiInfo
            {
               //...
            });

            c.SwaggerDoc("v2", new OpenApiInfo
            {
               //...
            });
            c.TagActionsBy(apiDesc => apiDesc.GetAreaName());

        });

记得配置你的区域路由：

  app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
            endpoints.MapControllerRoute(
            name: "Area",
            pattern: "{area:exists}/{controller=Home}/{action=Index}/{id?}"
            );
        });

在你的 ApiController 在你的 Area:

示例：

[Area("Area")]
[Produces("application/json")]
[Route("v1/Area/api/[controller]")]
[ApiController]
public class TodoController : ControllerBase
{        
    [HttpGet]
    public ActionResult<List<TodoItem>> GetAll()
    {
        return Ok();
    }

测试结果：

如何在带区域的 net core 3.1 Web 应用程序中配置 swagger？

How to configure swagger in netcore3.1 web application with an area?

c#

swagger

asp.net-core

webapi