C# .net core(.net 6) 配置使用swagger
注:项目创建参考:https://blog.csdn.net/lwpoor123/article/details/127789441;
1、.net 6 web api 创建自带swagger NuGet包(Swashbuckle.AspNetCore)。

2、添加自定义信息
1、配置项目输出包含API文档的文件(不配置xml文档路径默认路径)
注:配置显示注释需要生成Swagger xml文件
2、修改注册Swagger,添加自定义内容,显示接口注释
//注册Swagger builder.Services.AddEndpointsApiExplorer(); builder.Services.AddSwaggerGen(c => { #region 配置Swagger c.SwaggerDoc("V1.0", new OpenApiInfo { Title = "V1.0:接口文档", Description = $"API版本V1.0", Contact = new OpenApiContact { Name = "博客园燕钰达", Email = string.Empty, Url = new Uri("https://www.cnblogs.com/yyd-sun/") } }); #endregion #region 配置展示注释 { var path = Path.Combine(AppContext.BaseDirectory, "Demo02.xml"); // xml文档绝对路径 c.IncludeXmlComments(path, true); // true : 显示控制器层注释 c.OrderActionsBy(o => o.RelativePath); // 对action的名称进行排序,如果有多个,就可以看见效果了。 } #endregion });
3、修改使用Swagger部分
//测试环境启动 if (app.Environment.IsDevelopment()) { //使用Swagger app.UseSwagger(); app.UseSwaggerUI(c => { c.SwaggerEndpoint($"/swagger/V1.0/swagger.json", $"Demo01 V1.0"); }); }
注:版本信息部分保持一致
分类:
Core WebAPI
标签:
.net core webapi
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· CSnakes vs Python.NET:高效嵌入与灵活互通的跨语言方案对比
· DeepSeek “源神”启动!「GitHub 热点速览」
· 我与微信审核的“相爱相杀”看个人小程序副业
· Plotly.NET 一个为 .NET 打造的强大开源交互式图表库
· 上周热点回顾(2.17-2.23)