Swagger不显示接口注释

2023-12-20 19:24:08

如果 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

文章来源:https://blog.csdn.net/qq_39034148/article/details/135113471
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。