Asp.Net Core WebAPI使用Swagger时API隐藏和分组详解
编程学习 2021-07-04 22:41www.dzhlxh.cn编程入门
这篇文章主要给大家介绍了关于Asp.Net Core WebAPI使用Swagger时API隐藏和分组的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用Asp.Net Core具有一定的参考学习价值，需要的朋友们狼蚁网站SEO优化来一起学习学习吧
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>();
/