Swagger不显示接口注释

最新推荐文章于 2025-06-06 01:17:03 发布

码农甘道夫

最新推荐文章于 2025-06-06 01:17:03 发布

阅读量3k

点赞数 9

CC 4.0 BY-SA版权

分类专栏： C# 锦集文章标签： .net core swagger

本文链接：https://blog.csdn.net/qq_39034148/article/details/135113471

C# 同时被 2 个专栏收录

68 篇文章

订阅专栏

锦集

25 篇文章

订阅专栏

本文指导如何修复Swagger不显示接口注释问题：确认是否启用XML注释文件生成并放在正确位置，以及在Program.cs中添加Swagger配置，指定XML文件路径。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

如果 Swagger 不显示接口注释，请检查以下两点：

1、缺少 XML 注释文件：Swagger 默认使用 XML 注释文件中的注释来生成接口文档。确保在项目的生成设置中启用了 XML 文档生成，并将生成的 XML 注释文件放置在与生成的 DLL 文件相同的目录下。
![在这里插入图片描述](https://img-blog.csdnimg.cn/direct/2378981a7d074f33b979519fc56451c5.png

请在右击->属性->生成

在文档文件勾选生成包含API文档的文件，路径可以为空指向默认路径。

2、修改Program.cs文件，在Build之前增加Swagger的配置项

#region Swagger 配置
builder.Services.AddSwaggerGen(options =>
{
    options.SwaggerDoc("v1", new OpenApiInfo
    {
        Version = "v1",
        Title = "欧莱雅-费用报告API",
        Description = "API"
    });
    var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename));
});
#endregion