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

最新推荐文章于 2024-07-23 02:22:33 发布

Daaave

最新推荐文章于 2024-07-23 02:22:33 发布

阅读量1.4k

点赞数

CC 4.0 BY-SA版权

分类专栏： .NET 7 技巧文章标签： asp.net

本文链接：https://blog.csdn.net/sinat_41844660/article/details/128787372

.NET 7 技巧专栏收录该内容

1 篇文章

订阅专栏

本文介绍如何在ASP.NET Core Web API项目中配置Swagger以显示接口注释。通过生成XML文档并将其集成到Swagger中，可以实现API文档的自动生成与展示。

一、刚创建的ASP.NET Core Web API 模板，打开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);
});