Asp.Net Core WebAPI使用Swagger时API隐藏和分组详解
更新时间：2019年04月04日 10:23:38 作者：进击的辣条
这篇文章主要给大家介绍了关于Asp.Net Core WebAPI使用Swagger时API隐藏和分组的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用Asp.Net Core具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
1、前言
为什么我们要隐藏部分接口？
因为我们在用swagger代替接口的时候，难免有些接口会直观的暴露出来，比如我们结合Consul一起使用的时候，会将健康检查接口以及报警通知接口暴露出来，这些接口有时候会出于方便考虑，没有进行加密，这个时候我们就需要把接口隐藏起来，只有内部的开发者知道。
为什么要分组？
通常当我们写前后端分离的项目的时候，难免会遇到编写很多接口供前端页面进行调用，当接口达到几百个的时候就需要区分哪些是框架接口，哪些是业务接口，这时候给swaggerUI的接口分组是个不错的选择。
swagger的基本使用这里将不再赘述，可以阅读微软官方文档，即可基本使用
2、swaggerUI中加入授权请求
新建HttpHeaderOperationFilter操作过滤器，继承Swashbuckle.AspNetCore.SwaggerGen.IOperationFilter接口，实现Apply方法
/// <summary>
/// swagger请求头
/// </summary>
public class HttpHeaderOperationFilter : IOperationFilter
{
public void Apply(Operation operation, OperationFilterContext context)
{
#region 新方法
if (operation.Parameters == null)
{
operation.Parameters = new List<IParameter>();
}
if (context.ApiDescription.TryGetMethodInfo(out MethodInfo methodInfo))
{
if (!methodInfo.CustomAttributes.Any(t => t.AttributeType == typeof(AllowAnonymousAttribute))
&&!(methodInfo.ReflectedType.CustomAttributes.Any(t => t.AttributeType == typeof(AuthorizeAttribute))))
{
operation.Parameters.Add(new NonBodyParameter
{
Name = “Authorization”,
In = “header”,
Type = “string”,
Required = true,
Description = “请输入Token，格式为bearer XXX”
});
}
}
#endregion
#region 已过时
//if (operation.Parameters == null)
//{
// operation.Parameters = new List<IParameter>();
//}
//var actionAttrs = context.ApiDescription.ActionAttributes().ToList();
//var isAuthorized = actionAttrs.Any(a => a.GetType() == typeof(AuthorizeAttribute));
//if (isAuthorized == false)
//{
// var controllerAttrs = context.ApiDescription.ControllerAttributes();
// isAuthorized = controllerAttrs.Any(a => a.GetType() == typeof(AuthorizeAttribute));
//}
//var isAllowAnonymous = actionAttrs.Any(a => a.GetType() == typeof(AllowAnonymousAttribute));
//if (isAuthorized && isAllowAnonymous == false)
//{
// operation.Parameters.Add(new NonBodyParameter
// {
// Name = “Authorization”,
// In = “header”,
// Type = “string”,
// Required = true,
// Description = “请输入Token，格式为bearer XXX”
// });
//}
#endregion
}
}
然后修改Startup.cs中的ConfigureServices方法，添加我们自定义的HttpHeaderOperationFilter过滤器
public IServiceProvider ConfigureServices(IServiceCollection services)
{
…
services.AddSwaggerGen(c =>
{
…
c.OperationFilter<HttpHeaderOperationFilter>();
});
…
}
这时候我们再访问swaggerUI就可以输入Token了
3、API分组
修改Startup.cs中的ConfigureServices方法，添加多个swagger文档
public IServiceProvider ConfigureServices(IServiceCollection services)
{
…
services.AddSwaggerGen(c =>
{
c.SwaggerDoc(“v1”, new Info
{
Version = “v1”,
Title = “接口文档”,
Description = “接口文档-基础”,
TermsOfService = “”,
Contact = new Contact
{
Name = “XXX1111”,
Email = “[email protected]”,
Url = “”
}
});
c.SwaggerDoc(“v2”, new Info
{
Version = “v2”,
Title = “接口文档”,
Description = “接口文档-基础”,
TermsOfService = “”,
Contact = new Contact
{
Name = “XXX2222”,
Email = “[email protected]”,
Url = “”
}
});
//反射注入全部程序集说明
GetAllAssemblies().Where(t => t.CodeBase.EndsWith(“Controller.dll”)).ToList().ForEach(assembly =>
{
c.IncludeXmlComments(assembly.CodeBase.Replace(“.dll”, “.xml”));
});
c.OperationFilter<HttpHeaderOperationFilter>();
//c.DocumentFilter<HiddenApiFilter>();
});
…
}
修改Startup.cs中的Configure方法，加入
public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
{
…
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint(“/swagger/v2/swagger.json”, “接口文档-基础”);//业务接口文档首先显示
c.SwaggerEndpoint(“/swagger/v1/swagger.json”, “接口文档-业务”);//基础接口文档放后面后显示
c.RoutePrefix = string.Empty;//设置后直接输入IP就可以进入接口文档
});
…
}
然后还要在我们的控制器上面标注swagger文档的版本
这时候我们就可以将接口文档进行分组显示了
4、API隐藏
创建自定义隐藏特性HiddenApiAttribute.cs
/// <summary>
/// 隐藏swagger接口特性标识
/// </summary>
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public class HiddenApiAttribute:System.Attribute
{
}
创建API隐藏过滤器HiddenApiFilter继承Swashbuckle.AspNetCore.SwaggerGen.IDocumentFilter接口，实现Apply方法
/// <summary>
/// 自定义Swagger隐藏过滤器
/// </summary>
public class HiddenApiFilter : IDocumentFilter
{
public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context)
{
foreach (ApiDescription apiDescription in context.ApiDescriptions)
{
if (apiDescription.TryGetMethodInfo(out MethodInfo method))
{
if (method.ReflectedType.CustomAttributes.Any(t=>t.AttributeType==typeof(HiddenApiAttribute))
|| method.CustomAttributes.Any(t => t.AttributeType == typeof(HiddenApiAttribute)))
{
string key = “/” + apiDescription.RelativePath;
if (key.Contains(“?”))
{
int idx = key.IndexOf(“?”, System.StringComparison.Ordinal);
key = key.Substring(0, idx);
}
swaggerDoc.Paths.Remove(key);
}
}
}
}
}
在Startup.cs中使用HiddenApiFilter
public IServiceProvider ConfigureServices(IServiceCollection services)
{
…
services.AddSwaggerGen(c =>
{
c.SwaggerDoc(“v1”, new Info
{
Version = “v1”,
Title = “接口文档”,
Description = “接口文档-基础”,
TermsOfService = “”,
Contact = new Contact
{
Name = “XXX1111”,
Email = “[email protected]”,
Url = “”
}
});
c.SwaggerDoc(“v2”, new Info
{
Version = “v2”,
Title = “接口文档”,
Description = “接口文档-基础”,
TermsOfService = “”,
Contact = new Contact
{
Name = “XXX2222”,
Email = “[email protected]”,
Url = “”
}
});
//反射注入全部程序集说明
GetAllAssemblies().Where(t => t.CodeBase.EndsWith(“Controller.dll”)
&& !t.CodeBase.Contains(“Common.Controller.dll”)).ToList().ForEach(assembly =>
{
c.IncludeXmlComments(assembly.CodeBase.Replace(“.dll”, “.xml”));
});
c.OperationFilter<HttpHeaderOperationFilter>();
c.DocumentFilter<HiddenApiFilter>();
});
…
}
示例：
我这里提供了Consul的心跳检车接口
但是在接口文档中并没有显示出来
总结
以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，谢谢大家对华域联盟的支持。
您可能感兴趣的文章:Asp.net core WebApi 使用Swagger生成帮助页实例.Net Core2.1 WebAPI新增Swagger插件详解.NET Core利用swagger进行API接口文档管理的方法详解Asp.Net Core使用swagger生成api文档的完整步骤
core
webapi
swagger
相关文章
asp.net 序列化and反序列化演示实质上序列化机制是将类的值转化为一个一般的（即连续的）字节流，然后就可以将该流写到磁盘文件或任何其他流化目标上。而要想实际的写出这个流，就要使用那些实现了IFormatter接口的类里的Serialize和Deserialize方法。 2008-10-10
ASP.NET MVC5网站开发之用户添加和浏览2（七）这篇文章主要为大家详细介绍了ASP.NET MVC5网站开发之用户添加和浏览，感兴趣的小伙伴们可以参考一下 2016-08-08
IP地址与整数之间的转换实现代码(asp.net)把这个整数转换成一个32位二进制数。从左到右，每8位进行一下分割，得到4段8位的二进制数，把这些二进制数转换成整数然后加上”。”就是这个ip地址了 2012-09-09
轻松解决asp.net用户ASPNET登录失败问题的方法分享这篇文章介绍了asp.net用户ASPNET登录失败问题的方法，有需要的朋友可以参考一下 2013-11-11
ASP.Net全局变量的设置和读取方法ASP.Net全局变量的设置和读取方法… 2006-12-12
ASP.Net 上传图片并生成高清晰缩略图ASP.Net 上传图片并生成高清晰缩略图的代码 2009-02-02
ASP.NET MVC错误处理的对应解决方法这篇文章主要为大家详细介绍了ASP.NET MVC错误处理的对应解决方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下 2018-03-03
asp.net core 2.0 webapi集成signalr(实例讲解)下面小编就为大家分享一篇asp.net core 2.0 webapi集成signalr的实例讲解，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧 2017-11-11
.Net Core简单使用Mvc内置的Ioc（续）怎样直接获取Ioc中的实例对象，而不是以构造函数的方式进行获取呢？这篇文章继续为大家介绍.Net Core简单使用Mvc内置的Ioc 2018-03-03
DataGridView展开与收缩功能实现我们今天将要讲到DataGridView之行的展开与收缩，包括功能是如何实现的，感兴趣的小伙伴们可以参考一下 2015-09-09
最新评论
评论(0)