.net WebAPI Swagger 显示注释

       在使用VS开发WebAPI项目时，项目自动集成了Swagger。项目运行时即可显示Swagger页面，上面展示了开发好了所有服务接口，可以通过它测试接口服务和数据，非常方便开发者。其中对于接口的描述（注释）也必不可少。下面是如何配置显示接口服务注释：

1、在接口CityWeatherController.cs文件中增加注释：

 /// <summary>
 /// 通过cityId获取天气信息
 /// </summary>
 /// <returns></returns>
 [HttpGet]
 [Route("{cityId:int}")]
 public IEnumerable<WeatherForecast> GetUserInfo()
 {
     return Enumerable.Range(1, 5).Select(index => new WeatherForecast
     {
         Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
         TemperatureC = Random.Shared.Next(-20, 55),
         Summary = Summaries[Random.Shared.Next(Summaries.Length)]
     })
     .ToArray();
 }

2、在项目属性中找到“生成”-“输出”，勾上“文档文件”：

3、进入program.cs中按照一下代码替换“builder.Services.AddSwaggerGen();”：

builder.Services.AddSwaggerGen(option =>
{
    #region 显示Swagger API注释
    string basePath = AppContext.BaseDirectory;//项目生成目录
    string xmlPath = Path.Combine(basePath, "WebAPIDemo.xml");//注释文件名（路径）
    option.IncludeXmlComments(xmlPath);
    #endregion
});