在dotnet学习中,关于Swagger的XML注释问题-526互联

使用`dotnet` 的命令创建的`webapi`项目中, 是有预置`swagger`的功能, 跟随官网文档引导开启了`swagger`对`XML`注释的支持. 发现`controller`上面的注释没有生效, 查看`IncludeXmlComments` 方法时发现有一个参数`includeControllerXmlComments`默认为`false`

namespace Microsoft.Extensions.DependencyInjection // SwaggerGenOptionsExtensions.cs
 
  // .......
public static void IncludeXmlComments(
  this SwaggerGenOptions swaggerGenOptions,
  string filePath,
  bool includeControllerXmlComments = false)
  {
    swaggerGenOptions.IncludeXmlComments((Func<XPathDocument>) (() => new XPathDocument(filePath)), includeControllerXmlComments);
  }

传入`includeControllerXmlComments`为`true`并重启,`controller`的xml注释生效

// Program.cs
// ......
if (builder.Environment.IsDevelopment())
{
    builder.Services.AddSwaggerGen(options =>
    {
        options.SwaggerDoc("v1",
            new OpenApiInfo { Title = "这是标题", Version = "v1", Description = "这是描述" });
        var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
        options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename), true);
        options.OrderActionsBy(o => o.RelativePath);
    });
}