使用Magicodes.SwaggerUI快速配置SwaggerUI以及设置API分组
2024-09-01 16:21:33
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);
}
最新文章
- windows命令——taskkill
- visual studio 2015中的webapi生成helpPage，页面不显示方法说明问题解决
- PHP 全局变量 $_REQUEST 的分析
- TextView.setTextColor颜色值的理解
- GO语言练习：网络编程 TCP 示例
- Android课程---视图组件的总结
- 【erlang】IPv6格式转IPv4
- [CareerCup] 8.8 Othello Game 黑白棋游戏
- Appium+Maven+TestNG(ReportNG)环境搭建（详细过程）
- hdu 4901
- vs2010中的快捷键
- HDOJ-ACM1006(JAVA)
- 如何创建WIN服务
- Linux命令之nano -
- NET Framework 4.5新特性 数据库的连接加密保护。
- ACM Red and Black
- 【工利其器】必会工具之（二）Android开发者官网篇
- 利用GCD 中的 dispatch_source_timer 给tableViewCell添加动态刷新的计时/倒计时功能
- SpringBoot系列——aop 面向切面
- 体验usually.js的管道函数——pipe函数