312 Documentation Comments（实现打开Swagger页面，路由后面显示方法的文档注释）

实现打开Swagger页面，路由后面显示方法的文档注释

1、为方法添加文档注释

 // GET: api/Cities
 /// <summary>
 /// To get list of cities (including cityID nad city name) from 'cities' table
 /// </summary>
 /// <returns></returns>
 [HttpGet]
 public async Task<ActionResult<IEnumerable<City>>> GetCities()
 {
     var cities = await _context.Cities.OrderBy(c => c.CityName).ToListAsync();

     return cities;
 }

2、设置xml路径

首先勾选Generate a file containing API documentation.

然后在下方填写路径，api.xml表示在项目下面生成文件api.xml，每次Build都会重新生成；

3、更新Program.cs中的AddSwaggerGen方法

//Swagger
builder.Services.AddEndpointsApiExplorer(); //generates description for all endpoints
builder.Services.AddSwaggerGen(options =>
{
    options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "api.xml"));
}); //generates OpenAPI specification

var app = builder.Build();

结果

程序运行后可以看到Swagger页面，路由后面有了文档注释的内容

Gitee获取源码：

https://gitee.com/huang_jianhua0101/asp.-net-core-8.git