使用Magicodes.SwaggerUI快速配置SwaggerUI以及设置API分组
Magicodes.SwaggerUI
快速配置和集成SwaggerUI
特点
-
通过配置文件简单配置即可完成SwaggerUI的API格式JSON生成和集成
-
支持API分组和隐藏
-
支持自定义页面和验证
Nuget包
联系我们
订阅号
关注“麦扣聊技术”微信订阅号可以获得最新文章、教程、文档。
QQ群
-
编程交流群<85318032>
-
产品交流群<897857351>
文档官网&官方博客
其他开源库
更新日志
2019.10.21
-
【Nuget】Magicodes.SwaggerUI 2.0.1
-
【升级】单个文档不分组,显示所有API
-
【梳理】梳理目录结构
-
【修复】修复本地开发环境运行时不加载文档注释的问题
-
【修改】自动移除GroupUrlPrefix的前后空格以及“/”前缀
-
【升级】在全局隐藏API的基础上,支持分组API隐藏
-
【升级】API隐藏支持HTTP方法配置,默认“*”
2019.10.19
-
【升级】支持API分组,支持非侵入式配置,无需修改代码,仅通过配置即可完成API分组(见下面示例)
-
【重构】重构整体逻辑
Demo
配置Demo
"SwaggerDoc": { "IsEnabled": "true", //将枚举值以字符串显示 "DescribeAllEnumsAsStrings": false, "SwaggerDocInfos": [ { "IsEnabled": "true", "Title": "APP1 API文档", "Version": "v1", "GroupName": "App1", "Description": "", "Contact": { "Name": "心莱科技Team1", "Email": "xinlai@xin-lai.com" }, "GroupUrlPrefix": "api/app1/" }, { "IsEnabled": "true", "Title": "APP2 API文档", "Version": "v2", "GroupName": "App2", "Description": "", "Contact": { "Name": "心莱科技Team2", "Email": "xinlai@xin-lai.com" }, "GroupUrlPrefix": "api/app2/" } ], "HiddenApi": { "IsEnabled": "true", "HiddenUrls": "app1/Values/{id}" }, "UseFullNameForSchemaId": "false" }
注入代码:
//添加自定义API文档生成(支持文档配置) public IServiceProvider ConfigureServices(IServiceCollection services) { services.AddCustomSwaggerGen(_appConfiguration); } public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory) { //启用自定义API文档(支持文档配置) app.UseCustomSwaggerUI(_appConfiguration); }
作者:雪雁
出处:http://www.cnblogs.com/codelove/
沟通渠道:编程交流群<85318032> 产品交流群<897857351>
如果喜欢作者的文章,请关注【麦扣聊技术】订阅号以便第一时间获得最新内容。本文版权归作者和湖南心莱信息科技有限公司共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。
静听鸟语花香,漫赏云卷云舒。
出处:http://www.cnblogs.com/codelove/
沟通渠道:编程交流群<85318032> 产品交流群<897857351>
如果喜欢作者的文章,请关注【麦扣聊技术】订阅号以便第一时间获得最新内容。本文版权归作者和湖南心莱信息科技有限公司共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。
静听鸟语花香,漫赏云卷云舒。

【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 如何编写易于单元测试的代码
· 10年+ .NET Coder 心语,封装的思维:从隐藏、稳定开始理解其本质意义
· .NET Core 中如何实现缓存的预热?
· 从 HTTP 原因短语缺失研究 HTTP/2 和 HTTP/3 的设计差异
· AI与.NET技术实操系列:向量存储与相似性搜索在 .NET 中的实现
· 10年+ .NET Coder 心语 ── 封装的思维:从隐藏、稳定开始理解其本质意义
· 地球OL攻略 —— 某应届生求职总结
· 提示词工程——AI应用必不可少的技术
· Open-Sora 2.0 重磅开源!
· 周边上新:园子的第一款马克杯温暖上架
2015-11-08 Magicodes.WeiChat——使用OAuth 2.0获取微信用户信息