.Net7配置swagger进行添加接口注释

提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档

文章目录


前言

".NET 7" 是指.NET 平台的第七个主要版本,是微软开发的一个跨平台应用开发框架。


一、创建Web API项目

  1. 在VS 2022中 选择 ASP .NET Core Web API 项目 进行创建,填写项目名称和解决方案名称,点击 "下一步"

  2. 勾选 启用 OPenAPI 支持 以及 使用控制器 两项

  3. 项目启动,可以看到 Swagger 已经成功运行出来了

二、配置Swagger

1.注释配置

我们在代码通常会对api接口注释,而这部分注释也希望能通过Swagger展示出来,应该如何做呢

(1) 通过NuGet包管理器安装Swashbuckle.AspNetCore包(创建项目时默认已添加,无需再次安装)

(2)配置Swagger生成器:在Program.cs文件中,添加以下代码以配置

bash 复制代码
services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "Web API", Version = "v1" });
});
  1. 启用Swagger中间件
bash 复制代码
app.UseSwagger();
app.UseSwaggerUI(c => {
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Web API V1");
});
  1. 在控制器的操作方法上添加注释:在控制器操作方法上,添加XML注释以描述该方法
bash 复制代码
/// <summary>
/// This is a sample operation with XML comments
/// </summary>
/// <response code="200">Success</response>
[HttpGet(Name = "GetWeatherForecast")]
  1. 在项目 " 属性" 中启用XML文档生成,将XML文档文件包含到Swagger配置中

    如果不配置 生成API文档的文件,则Swagger UI 会报错
  1. 配置Swagger显示注释:在Swagger配置中将XML文档文件包含在注释中,以便Swagger可以读取和显示XML
bash 复制代码
services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "Your API Name", Version = "v1" });
    
    // Configure Swagger to use the XML documentation file generated by Visual Studio
    var xmlFile = $"{Assembly.GetEntryAssembly().GetName().Name}.xml";
    var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
    c.IncludeXmlComments(xmlPath);
});
  1. 配置完成,重新生成项目,此时可以看到在 关于 GetWeatherForecast接口注释 已经在 " Swagger UI" 中成功显示了

总结

以上就是今天要讲的内容,本文通过以上步骤,可以配置Swagger以显示.NET代码中的接口注释。希望这些说明可以帮助您实现您的目标。如果您需要进一步的帮助,请随时告诉我。

相关推荐
Mintopia19 小时前
🚀 Next.js 全栈 Web Vitals 监测与 Lighthouse 分析
前端·javascript·全栈
Mintopia19 小时前
🤖 AIGC + CMS:内容管理系统智能化的核心技术支撑
前端·javascript·aigc
HelloGitHub19 小时前
这款开源调研系统越来越“懂事”了
前端·开源·github
whysqwhw19 小时前
hippy的主要原理
前端
子兮曰19 小时前
🚀95%的前端开发者都踩过坑:JavaScript循环全解析,从基础到高阶异步迭代
前端·javascript·性能优化
2401_8534068819 小时前
Tdesign-React 组件 Card 实现头部固定,内容区单独可滚动
前端·react.js·tdesign
蓝倾97619 小时前
小红书获取用户作品列表API接口操作指南
java·服务器·前端·python·电商开放平台·开放api接口
小桥风满袖19 小时前
极简三分钟ES6 - 数值的扩展
前端·javascript
北辰alk19 小时前
React 组件间数据共享全方位指南:从 Props 到状态管理
前端
薛定谔的算法19 小时前
手写React:从Dideact理解前端框架的核心原理
前端·react.js·架构