ASP.NET Core Web API(.NET 7)在Swagger页面中添加注释

一、刚创建的ASP.NET Core Web API 模板,打开Swagger页面时,是没有注释的

在接口上写了注释,但是Swagger页面未显示
在接口上写了注释,但是Swagger页面未显示
在接口上写了注释,但是Swagger页面未显示

二、生成包含API文档的文件

右键项目属性,在生成>输出中,勾选生成包含API文档的文件
在这里插入图片描述
生成了如下文件
在这里插入图片描述

三、配置Program.cs

添加如下代码,主要是找到上面生成 .xml 文件的位置

builder.Services.AddSwaggerGen(a =>
{
    
    
    a.SwaggerDoc("v1", new OpenApiInfo {
    
     Title = "练习 测试", Version = "第一版", Description = "描述吧" });
    var curr = AppContext.BaseDirectory;
    a.IncludeXmlComments(curr + "/WebApplication1.xml", true);
});

在这里插入图片描述

四、效果

在这里插入图片描述

猜你喜欢

转载自blog.csdn.net/sinat_41844660/article/details/128787372