C# web api Swagger

一、打开XML,注释生成

1、项目属性->生成->输出

2、勾选 文档文件

image

二、配置

Program.cs

#region 配置Swagger
builder.Services.AddSwaggerGen(c => 
{
    c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo { Title = "测试Api", Version = "v1" });

    // 获取当前专案生成的 XML 文档
    var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    Console.WriteLine(xmlFilename);
    // 完整路径
    var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFilename);
    // 让 Swagger 载入文档
    c.IncludeXmlComments(xmlPath, includeControllerXmlComments: true);
});
#endregion

三、使用

1、注释

2、特性 [Required]

 

posted @ 2026-07-13 15:42  市丸银  阅读(3)  评论(0)    收藏  举报