.NET Core Swagger 的分组使, 以及相同Action能被多个分组公用,同时加载出尚未分组的数据出来
1.本文章参考 点击链接跳转 改写的 一对多分组模式。需要一对一的可以参考
2.本文主要讲的是 一对多 分组公用, 同时把尚未分组的加载出来
3.效果演示GIF图:
具体操作代码如下:
1.在项目创建一个目录(ApiGroup),然后创建三个类,分别为ApiGroupAttribute.cs(控制器特性),ApiGroupNames.css(系统分组枚举),GroupInfoAttribute.cs(给系统分组枚举值增加相关信息的特性,这个主要是用于在Swagger分组时可关联Title,Version,Description值)
ApiGroupAttribute.cs代码如下
/// <summary>
/// 系统分组特性
/// </summary>
public class ApiGroupAttribute : Attribute
{
public ApiGroupAttribute(params ApiGroupNames[] name)
{
GroupName = name;
}
public ApiGroupNames[] GroupName { get; set; }
}
ApiGroupNames.cs代码如下
/// <summary>
/// 系统分组枚举值
/// </summary>
public enum ApiGroupNames
{
[GroupInfo(Title = "All", Description = "All接口", Version = "")]
All = 0,
[GroupInfo(Title = "尚未分组", Description = "尚未分组相关接口", Version = "")]
NoGroup = 1,
[GroupInfo(Title = "登录认证", Description = "登录认证相关接口", Version = "")]
Login = 2,
[GroupInfo(Title = "IT", Description = "登录认证相关接口", Version = "")]
It = 3,
[GroupInfo(Title = "人力资源", Description = "登录认证相关接口", Version = "")]
Hr = 4,
[GroupInfo(Title = "系统配置", Description = "系统配置相关接口", Version = "")]
Config = 5
}
GroupInfoAttribute.cs代码如下
public class GroupInfoAttribute : Attribute
{
public string Title { get; set; }
public string Version { get; set; }
public string Description { get; set; }
}
******** 打开Startup.cs文件修改ConfigureServices方法(为了方便查看,只列出关于Swagger分组的关键代码)*************
//1.0 ConfigureServices 里面swagger 的设置
#region swagger var openApiInfo = new OpenApiInfo
{
Version = "v1",
Title = "WebApi",
Description = "A simple example ASP.NET Core Web API",
TermsOfService = new Uri("https://www.cnblogs.com/goodluckily/"),
Contact = new OpenApiContact
{
Name = "雨太阳",
Email = string.Empty,
Url = new Uri("https://www.cnblogs.com/goodluckily/")
},
License = new OpenApiLicense
{
Name = "许可证名字",
Url = new Uri("https://www.cnblogs.com/goodluckily/")
}
}; services.AddSwaggerGen(c =>
{
#region 分组方案二 //遍历ApiGroupNames所有枚举值生成接口文档,Skip(1)是因为Enum第一个FieldInfo是内置的一个Int值
typeof(ApiGroupNames).GetFields().Skip(1).ToList().ForEach(f =>
{
//获取枚举值上的特性
var info = f.GetCustomAttributes(typeof(GroupInfoAttribute), false).OfType<GroupInfoAttribute>().FirstOrDefault();
openApiInfo.Title = info?.Title;
openApiInfo.Version = info?.Version;
openApiInfo.Description = info?.Description;
c.SwaggerDoc(f.Name, openApiInfo);
}); //判断接口归于哪个分组
c.DocInclusionPredicate((docName, apiDescription) =>
{
if (!apiDescription.TryGetMethodInfo(out MethodInfo method)) return false;
//1.全部接口
if (docName == "All") return true;
//反射拿到控制器分组特性下的值
var actionlist = apiDescription.ActionDescriptor.EndpointMetadata.FirstOrDefault(x => x is ApiGroupAttribute);
//2.得到尚未分组的接口***************
if (docName == "NoGroup") return actionlist == null ? true : false;
//3.加载对应已经分好组的接口
if (actionlist != null)
{
//判断是否包含这个分组
var actionfilter = actionlist as ApiGroupAttribute;
return actionfilter.GroupName.Any(x => x.ToString().Trim() == docName);
}
return false;
}); #endregion //添加授权 //认证方式,此方式为全局添加 var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
c.IncludeXmlComments(xmlPath, true);
});
#endregion
2.0 Configure 里面swagger 的设置
#region Swagger app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.RoutePrefix = "swagger"; #region 分组方案二
//遍历ApiGroupNames所有枚举值生成接口文档,Skip(1)是因为Enum第一个FieldInfo是内置的一个Int值
typeof(ApiGroupNames).GetFields().Skip(1).ToList().ForEach(f =>
{
//获取枚举值上的特性
var info = f.GetCustomAttributes(typeof(GroupInfoAttribute), false).OfType<GroupInfoAttribute>().FirstOrDefault();
c.SwaggerEndpoint($"/swagger/{f.Name}/swagger.json", info != null ? info.Title : f.Name);
});
#endregion //swagger 默认折叠
//c.DocExpansion(Swashbuckle.AspNetCore.SwaggerUI.DocExpansion.None); //MiniProfiler用的
c.IndexStream = () => GetType().GetTypeInfo().Assembly.GetManifestResourceStream("WebApi.index.html");
}); #endregion
然后你F6生成一下,没出错的话,就Ctrl+F5看看,正常的话就会在Swagger右上角看到分组了。
*********************具体在 WeatherForecastController 里面的使用***************
1.单个Action特性 [ApiGroup(ApiGroupNames.Config)]
2.多个Action特性 [ApiGroup(ApiGroupNames.Login,ApiGroupNames.It)]
..............
具体详细的Controller代码如下
[ApiController]
[Route("[controller]")]
public class WeatherForecastController : Controller
{ private readonly ILogger<WeatherForecastController> _logger; private readonly IHttpContextAccessor _accessor;
public WeatherForecastController(ILogger<WeatherForecastController> logger, IHttpContextAccessor accessor)
{
_logger = logger;
_accessor = accessor;
}
/// <summary>
/// 多分组共用请求
/// </summary>
/// <returns></returns>
//[ProducesResponseType(201)]
//[ProducesResponseType(400)] [HttpGet("getLoginAndIT")]
[ApiGroup(ApiGroupNames.Login,ApiGroupNames.It)]
public IActionResult GetLoginAndIT()
{
return Json("GetLoginAndIT ok");
} [HttpGet("getConfig")]
[ApiGroup(ApiGroupNames.Config)]
public IActionResult GetConfig()
{
return Json("Config ok");
} [HttpGet("getHr")]
[ApiGroup(ApiGroupNames.Hr)] public IActionResult GetHr()
{
return Json("Hr ok");
} [HttpGet("getIt")]
[ApiGroup(ApiGroupNames.It)] public IActionResult GetIt()
{
return Json("GetIt ok");
}
/// <summary>
/// 获取Miniprofiler Index的 Script (尚未分组的)
/// </summary>
/// <returns></returns>
[HttpGet("getMiniprofilerScript")]
public IActionResult getMiniprofilerScript()
{
var htmlstr = MiniProfiler.Current.RenderIncludes(_accessor.HttpContext);
var script = htmlstr.Value;
return Json(script);
}
}
-----------至此结束 end ----------------------------------
有疑问意见等,欢迎大家讨论.......
.NET Core Swagger 的分组使, 以及相同Action能被多个分组公用,同时加载出尚未分组的数据出来的更多相关文章
- .NET Core配置文件加载与DI注入配置数据
.NET Core配置文件 在以前.NET中配置文件都是以App.config / Web.config等XML格式的配置文件,而.NET Core中建议使用以JSON为格式的配置文件,因为使用起来更 ...
- [转].NET Core配置文件加载与DI注入配置数据
本文转自:http://www.cnblogs.com/skig/p/6079187.html .NET Core配置文件 在以前.NET中配置文件都是以App.config / Web.config ...
- Web版RSS阅读器(二)——使用dTree树形加载rss订阅分组列表
在上一边博客<Web版RSS阅读器(一)——dom4j读取xml(opml)文件>中已经讲过如何读取rss订阅文件了.这次就把订阅的文件读取到页面上,使用树形结构进行加载显示. 不打算使用 ...
- 【ASP.NET Core】EF Core - “影子属性” 深入浅出经典面试题:从浏览器中输入URL到页面加载发生了什么 - Part 1
[ASP.NET Core]EF Core - “影子属性” 有朋友说老周近来博客更新较慢,确实有些慢,因为有些 bug 要研究,另外就是老周把部分内容转到直播上面,所以写博客的内容减少了一点. ...
- Asp.Net Core Swagger 接口分组(支持接口一对多暴露)
开始之前,先介绍下swagger常用方法. services.AddSwaggerGen //添加swagger中间件 c.SwaggerDoc //配置swagger文档,也就是右上角的下拉 ...
- EntityFramework Core饥饿加载忽略导航属性问题
前言 .NET Core项目利用EntityFramework Core作为数据访问层一直在进行中,一直没有过多的去关注背后生成的SQL语句,然后老大捞出日志文件一看,恩,有问题了,所以本文产生了,也 ...
- [翻译 EF Core in Action 2.4] 加载相关数据
Entity Framework Core in Action Entityframework Core in action是 Jon P smith 所著的关于Entityframework Cor ...
- 分享一个集成.NET Core+Swagger+Consul+Polly+Ocelot+IdentityServer4+Exceptionless+Apollo+SkyWalking的微服务开发框架
集成.NET Core+Swagger+Consul+Polly+Ocelot+IdentityServer4+Exceptionless+Apollo的微服务开发框架 Github源代码地址 htt ...
- .net core swagger汉化
基本swagger使用不再详解,具体百度其它帖子 1.将汉化的swagger js文件复制到项目根目录中 js代码如下 'use strict'; /** * Translator for docum ...
随机推荐
- GeoMesa 环境搭建
GeoMesa 环境搭建 版本 虚拟机安装 os centos7 Centos安装 CentOS安装Jdk并配置环境变量 hadoop.hbase环境部署 geomesa_hbase部署 geoser ...
- Java线程 - sleep()和wait()方法的区别, 线程阻塞BLOCKED和等待WAITING的区别
一. sleep()和wait()方法的区别 sleep()方法 sleep()方法是Thread类的方法,通过其定义可知是个native方法,在指定的时间内阻塞线程的执行.而且从其注释中可知,并不会 ...
- 在VirtualBox上安装Ubuntu-20.04
本文主要介绍如何在VirtualBox上安装Ubuntu-20.04 目录 下载VirtualBox 下载Ubuntu-20.04镜像 新建虚拟机 第一步:打开VirtualBox 第二步:设置虚拟机 ...
- 2019 Multi-University Training Contest 4.Divide the Stones(贪心)
题意:给你n和k (k|n) 有n个数 第i个数权值为i 要你求权值相同且分成k组 且每组的个数为n/k 思路:恶心构造题,首先对于总权值不能分为k份的 显然不能分成 然后 我们把n/k 分奇偶 我们 ...
- 【noi 2.6_162】Post Office(DP)
这题和"山区建小学"除了输入不同,其他都一样.(解析可见我的上一篇随笔) 但是,这次我对dis[][]加了一个优化,画一下图就可明白. 1 #include<cstdio&g ...
- python爬取QQVIP音乐
QQ音乐相比于网易云音乐加密部分基本上没有,但是就是QQ音乐的页面与页面之间的联系太强了,,导致下载一个音乐需要分析前面多个页面,找数据..太繁琐了 1.爬取链接:https://y.qq.com/ ...
- hdu5135 Little Zu Chongzhi's Triangles
Time Limit: 2000/1000 MS (Java/Others) Memory Limit: 512000/512000 K (Java/Others) Total Submissi ...
- hdu4770 Lights Against Dudely
Time Limit: 2000/1000 MS (Java/Others) Memory Limit: 32768/32768 K (Java/Others) Total Submission ...
- c文件二进制读取写入文件、c语言实现二进制(01)转化成txt格式文本、c读取文件名可变
c语言实现二进制(01)转化成txt格式文本: 下面的程序只能实现ascall对应字符转换,如果文件内出现中文字符,则会出现错误. 本程序要自己创建个文本格式的输入文件a1.txt,编译后能将文本文件 ...
- C# 之 dynamic
C#中的dynamic用于避免编译时类型检查,编译器在运行时获取类型. dynamic无法使用VisualStudio的intelliSense(智能感知),即调用dynamic修饰的对象的方法或字段 ...