.NET 拓展Swagger之【添加注释

开发运维 2023-10-04 大树 手机阅读

修改配置

#region Swagger的配置

builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen(option =>
{
    // xml 文档文件绝对路径--读取根据控制器生成的xml文件
    var file = Path.Combine(AppContext.BaseDirectory,
        "ZhaoXi.WebSiteApi.xml");
    // true: 显示控制器层注释
    option.IncludeXmlComments(file, true);
    // 对actuin的名称进行排序，如果有多个，就可以看到效果
    option.OrderActionsBy(o => o.RelativePath);
});
#endregion

image.png

修改属性

image.png

image.png

重新生成文件

image.png

查看xml

image.png

注意：xml文件名称要一致，否则运行时会报错

.NET 拓展Swagger之【添加注释-每日运维
测试

控制器注释

image.png

image.png

实体类注释

image.png

.NET 拓展Swagger之【添加注释-每日运维
下一节

.NET 拓展Swagger之【版本控制】 - 掘金 (juejin.cn)