Magicodes.SwaggerUI 已支持.NET Core 3.1
2023-09-11 14:15:07 时间
Magicodes.SwaggerUI
通过配置文件简单配置即可快速完成SwaggerUI的配置,包括:
- SwaggerUI的文档信息
- API分组
- API隐藏
- API JSON生成(枚举、API架构Id)
- 验证
- 自定义页面
支持.NET Core 2.2和3.1。版本日志和使用教程见下文。
注意:AddCustomSwaggerGen和UseCustomSwaggerUI已分别替换为“AddMagicodesSwaggerGen”、“UseMagicodesSwaggerUI”。
更新日志
2020.03.07
- 【Nuget】Magicodes.SwaggerUI 3.0.2
- 【升级】支持.NET Core 3.1
- 【重构】支持自定义逻辑编写:
- AddMagicodesSwaggerGen添加Action<SwaggerGenOptions, SwaggerConfigInfo>参数,可以实现自定义逻辑
- UseMagicodesSwaggerUI添加Action<SwaggerUIOptions, SwaggerConfigInfo>参数,可以实现自定义逻辑
2019.10.21
- 【Nuget】Magicodes.SwaggerUI 2.0.4
- 【升级】单个文档不分组,显示所有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", "Urls": [ { "Url": "app2/Values/{id}", "HttpMethod": "Delete" } ] } } ], "HiddenApi": { "IsEnabled": "true", "Urls": [ { "Url": "app1/Values/{id}" } ] }, "UseFullNameForSchemaId": "false" }
注入代码:
//添加自定义API文档生成(支持文档配置) public IServiceProvider ConfigureServices(IServiceCollection services) { services.AddMagicodesSwaggerGen(_appConfiguration); } public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory) { //启用自定义API文档(支持文档配置) app.UseMagicodesSwaggerUI(_appConfiguration); }
特点
- 通过配置文件简单配置即可完成SwaggerUI的API格式JSON生成和集成
- 支持API分组和隐藏
- 支持自定义页面和验证
Nuget包
名称 | Nuget |
---|---|
Magicodes.SwaggerUI |
Magicodes Nuget包推荐
相关Nuget包
名称 | 说明 | Nuget | GitHUb |
---|---|---|---|
Magicodes.IE.Excel | Excel导入导出 | dotnetcore/Magicodes.IE | |
Magicodes.IE.Core | 导入导出核心库 | dotnetcore/Magicodes.IE | |
Magicodes.IE.HTML | HTML导入导出 | dotnetcore/Magicodes.IE | |
Magicodes.IE.Pdf | Pdf导出 | dotnetcore/Magicodes.IE | |
Magicodes.IE.Word | Word导出 | dotnetcore/Magicodes.IE | |
Magicodes.IE.Csv | Csv导入导出 | dotnetcore/Magicodes.IE | |
Magicodes.WeChat.MiniProgram | 小程序SDK | Magicodes.WxMiniProgram.Sdk | |
Magicodes.Sms.Aliyun | 阿里云短信 | xin-lai/Magicodes.Sms | |
Magicodes.Sms.Core | 短信核心库 | xin-lai/Magicodes.Sms | |
Magicodes.Sms.Aliyun.Abp | 阿里云短信Abp模块 | xin-lai/Magicodes.Sms | |
Magicodes.Storage.Core | 通用存储核心库 | xin-lai/Magicodes.Storage | |
Magicodes.Storage.AliyunOss.Core | 阿里云OSS存储 | xin-lai/Magicodes.Storage | |
Magicodes.Storage.Local.Core | 本地存储 | xin-lai/Magicodes.Storage | |
Magicodes.Storage.Tencent.Core | 腾讯云存储 | xin-lai/Magicodes.Storage | |
Magicodes.Storage.Abp.Core | 通用存储ABP模块集成 | xin-lai/Magicodes.Storage | |
Magicodes.WeChat.SDK.Core | 微信SDK | xin-lai/Magicodes.WeChat.SDK | |
Magicodes.SwaggerUI | SwaggerUI API快速配置和分组 | xin-lai/Magicodes.SwaggerUI | |
Magicodes.Pay.Alipay | 支付宝支付库 | xin-lai/Magicodes.Pay | |
Magicodes.Pay.Notify | 支付通用回调库 | xin-lai/Magicodes.Pay | |
Magicodes.Pay.Wxpay | 微信支付库 | xin-lai/Magicodes.Pay | |
Magicodes.Pay.Alipay.Global | 国际支付宝支付库 | xin-lai/Magicodes.Pay | |
Magicodes.Pay.Allinpay | 通联支付库 | xin-lai/Magicodes.Pay | |
Magicodes.Pay.Abp | ABP 支付通用封装库 | xin-lai/Magicodes.Pay | |
Magicodes.Pay.Abp.Allinpay | ABP 通联支付模块 | xin-lai/Magicodes.Pay | |
Magicodes.Pay.Abp.Wxpay | ABP 微信支付模块 | xin-lai/Magicodes.Pay | |
Magicodes.Pay.Alipay.Global | ABP 国际支付宝模块 | xin-lai/Magicodes.Pay | |
Magicodes.Pay.Alipay | ABP 支付宝模块 | xin-lai/Magicodes.Pay | |
Magicodes.Abp.Castle.NLog | ABP Nlog支持模块 | xin-lai/Abp.Castle.NLog | |
Magicodes.WxMiniProgram.Sdk | 微信小程序SDK | xin-lai/Magicodes.WxMiniProgram.Sdk | |
Magicodes.WxMiniProgram.Sdk.Abp | 微信小程序SDK Abp模块 | xin-lai/Magicodes.WxMiniProgram.Sdk | |
Magicodes.Dingtalk.SDK | 钉钉SDK | xin-lai/Magicodes.Dingtalk.SDK | |
Magicodes.DynamicSqlApi.Core | 根据SQL自动解析生成动态API | Magicodes.DynamicSqlApi | |
Magicodes.DynamicSqlApi.All | 根据SQL自动解析生成动态API | Magicodes.DynamicSqlApi | |
Magicodes.DynamicSqlApi.CsScript | 根据SQL自动解析生成动态API | Magicodes.DynamicSqlApi | |
Magicodes.DynamicSqlApi.Dapper | 根据SQL自动解析生成动态API | Magicodes.DynamicSqlApi | |
Magicodes.DynamicSqlApi.SqlServer | 根据SQL自动解析生成动态API | Magicodes.DynamicSqlApi |
联系我们
其他开源库
相关文章
- .NET Core 1.1日期解析无APi、SQL Server数据转换JSON
- abp(net core)+easyui+efcore实现仓储管理系统——ABP WebAPI与EasyUI结合增删改查之五(三十一)
- abp(net core)+easyui+efcore实现仓储管理系统——EasyUI之货物管理二 (二十)
- abp(net core)+easyui+efcore实现仓储管理系统——使用 WEBAPI实现CURD (十四)
- abp(net core)+easyui+efcore实现仓储管理系统——使用 WEBAPI实现CURD (十一)
- JavaScript日历控件开发 C# 读取 appconfig文件配置数据库连接字符串,和配置文件 List<T>.ForEach 调用异步方法的意外 ef 增加或者更新的习惯思维 asp.net core导入excel 一个二级联动
- List多个字段标识过滤 IIS发布.net core mvc web站点 ASP.NET Core 实战:构建带有版本控制的 API 接口 ASP.NET Core 实战:使用 ASP.NET Core Web API 和 Vue.js 搭建前后端分离项目 Using AutoFac
- C# -- HttpWebRequest 和 HttpWebResponse 的使用 C#编写扫雷游戏 使用IIS调试ASP.NET网站程序 WCF入门教程 ASP.Net Core开发(踩坑)指南 ASP.Net Core Razor+AdminLTE 小试牛刀 webservice创建、部署和调用 .net接收post请求并把数据转为字典格式
- .NET Core实战项目之CMS 第二章 入门篇-快速入门ASP.NET Core看这篇就够了 [WPF]为旧版本的应用添加触控支持 js css等静态文件版本控制,一处配置多处更新.net版【原创】 C#图片处理,缩略图制作 SqlDataReader 结果集 转成 DataTable DataTable转成List集合 如何使用linq读取DataTable集合?
- SQL 横转竖 、竖专横 (转载) 使用Dapper.Contrib 开发.net core程序,兼容多种数据库 C# 读取PDF多级书签 Json.net日期格式化设置 ASPNET 下载共享文件 ASPNET 文件批量下载 递归,循环,尾递归 利用IDisposable接口构建包含非托管资源对象 《.NET 进阶指南》读书笔记2------定义不可改变类型
- 项目开发中的一些注意事项以及技巧总结 基于Repository模式设计项目架构—你可以参考的项目架构设计 Asp.Net Core中使用RSA加密 EF Core中的多对多映射如何实现? asp.net core下的如何给网站做安全设置 获取服务端https证书 Js异常捕获
- C# 嵌入dll 动软代码生成器基础使用 系统缓存全解析 .NET开发中的事务处理大比拼 C#之数据类型学习 【基于EF Core的Code First模式的DotNetCore快速开发框架】完成对DB First代码生成的支持 基于EF Core的Code First模式的DotNetCore快速开发框架 【懒人有道】在asp.net core中实现程序集注入
- IT咨询顾问:一次吐血的项目救火 java或判断优化小技巧 asp.net core Session的测试使用心得 【.NET架构】BIM软件架构02:Web管控平台后台架构 NetCore入门篇:(十一)NetCore项目读取配置文件appsettings.json 使用LINQ生成Where的SQL语句 js_jquery_创建cookie有效期问题_时区问题
- C#编译器优化那点事 c# 如果一个对象的值为null,那么它调用扩展方法时为甚么不报错 webAPI 控制器(Controller)太多怎么办? .NET MVC项目设置包含Areas中的页面为默认启动页 (五)Net Core使用静态文件 学习ASP.NET Core Razor 编程系列八——并发处理
- 运用.net core配合VS 2015制作nuget包
- 使用批处理根据项目工程文件生成Nuget包并发布(支持.NET Core)
- [WPF]是时候将WPF控件库从.Net Framework升级到.NET Core 3.1
- .NET-WEB网站部署的过程中需要注意的问题
- 一、.net core 集成vue
- 微软的.NET Core开始支持Raspberry Pi 3
- .NET Core跨平台:使用.NET Core开发一个初心源商城总括
- .Net Core 简单定时任务框架封装