Asp.Net Core WebAPI使用Swagger时API隐藏与分组

简介: Asp.Net Core WebAPI使用Swagger时API隐藏与分组1、前言为什么我们要隐藏部分接口?因为我们在用swagger代替接口的时候,难免有些接口会直观的暴露出来,比如我们结合Consul一起使用的时候,会将健康检查接口以及报警通知接口暴露出来,这些接口有时候会出于方便考虑,没有进行加密,这个时候我们就需要把接口隐藏起来,只有内部的开发者知道。

Asp.Net Core WebAPI使用Swagger时API隐藏与分组
1、前言
为什么我们要隐藏部分接口?

因为我们在用swagger代替接口的时候,难免有些接口会直观的暴露出来,比如我们结合Consul一起使用的时候,会将健康检查接口以及报警通知接口暴露出来,这些接口有时候会出于方便考虑,没有进行加密,这个时候我们就需要把接口隐藏起来,只有内部的开发者知道。

为什么要分组?

通常当我们写前后端分离的项目的时候,难免会遇到编写很多接口供前端页面进行调用,当接口达到几百个的时候就需要区分哪些是框架接口,哪些是业务接口,这时候给swaggerUI的接口分组是个不错的选择。

swagger的基本使用这里将不再赘述,可以阅读微软官方文档,即可基本使用

2、swaggerUI中加入授权请求
新建 HttpHeaderOperationFilter 操作过滤器,继承 Swashbuckle.AspNetCore.SwaggerGen.IOperationFilter 接口,实现 Apply 方法
复制代码
///
/// swagger请求头
///
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 = "XXX1111@qq.com",
            Url = ""
        }
    });

    c.SwaggerDoc("v2", new Info
    {
        Version = "v2",
        Title = "接口文档",
        Description =  "接口文档-基础",
        TermsOfService = "",
        Contact = new Contact
        {
            Name = "XXX2222",
            Email = "XXX2222@qq.com",
            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
复制代码
///
/// 隐藏swagger接口特性标识
///
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public class HiddenApiAttribute:System.Attribute
{
}
复制代码
创建API隐藏过滤器 HiddenApiFilter 继承 Swashbuckle.AspNetCore.SwaggerGen.IDocumentFilter 接口,实现 Apply 方法
复制代码
///
/// 自定义Swagger隐藏过滤器
///
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 = "XXX1111@qq.com",
            Url = ""
        }
    });

    c.SwaggerDoc("v2", new Info
    {
        Version = "v2",
        Title = "接口文档",
        Description =  "接口文档-基础",
        TermsOfService = "",
        Contact = new Contact
        {
            Name = "XXX2222",
            Email = "XXX2222@qq.com",
            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的心跳检车接口

但是在接口文档中并没有显示出来

作者:一个大西瓜
出处:https://www.cnblogs.com/wyt007/

相关文章
|
2月前
|
开发框架 .NET 开发者
简化 ASP.NET Core 依赖注入(DI)注册-Scrutor
Scrutor 是一个简化 ASP.NET Core 应用程序中依赖注入(DI)注册过程的开源库,支持自动扫描和注册服务。通过简单的配置,开发者可以轻松地从指定程序集中筛选、注册服务,并设置其生命周期,同时支持服务装饰等高级功能。适用于大型项目,提高代码的可维护性和简洁性。仓库地址:&lt;https://github.com/khellang/Scrutor&gt;
60 5
|
1月前
|
开发框架 数据可视化 .NET
.NET 中管理 Web API 文档的两种方式
.NET 中管理 Web API 文档的两种方式
42 14
|
2月前
|
开发框架 算法 中间件
ASP.NET Core 中的速率限制中间件
在ASP.NET Core中,速率限制中间件用于控制客户端请求速率,防止服务器过载并提高安全性。通过`AddRateLimiter`注册服务,并配置不同策略如固定窗口、滑动窗口、令牌桶和并发限制。这些策略可在全局、控制器或动作级别应用,支持自定义响应处理。使用中间件`UseRateLimiter`启用限流功能,并可通过属性禁用特定控制器或动作的限流。这有助于有效保护API免受滥用和过载。 欢迎关注我的公众号:Net分享 (239字符)
61 1
|
3月前
|
开发框架 .NET 程序员
驾驭Autofac,ASP.NET WebApi实现依赖注入详细步骤总结
Autofac 是一个轻量级的依赖注入框架,专门为 .NET 应用程序量身定做,它就像是你代码中的 "魔法师",用它来管理对象的生命周期,让你的代码更加模块化、易于测试和维护
101 4
驾驭Autofac,ASP.NET WebApi实现依赖注入详细步骤总结
|
3月前
|
开发框架 .NET C#
在 ASP.NET Core 中创建 gRPC 客户端和服务器
本文介绍了如何使用 gRPC 框架搭建一个简单的“Hello World”示例。首先创建了一个名为 GrpcDemo 的解决方案,其中包含一个 gRPC 服务端项目 GrpcServer 和一个客户端项目 GrpcClient。服务端通过定义 `greeter.proto` 文件中的服务和消息类型,实现了一个简单的问候服务 `GreeterService`。客户端则通过 gRPC 客户端库连接到服务端并调用其 `SayHello` 方法,展示了 gRPC 在 C# 中的基本使用方法。
64 5
在 ASP.NET Core 中创建 gRPC 客户端和服务器
|
2月前
|
开发框架 缓存 .NET
GraphQL 与 ASP.NET Core 集成:从入门到精通
本文详细介绍了如何在ASP.NET Core中集成GraphQL,包括安装必要的NuGet包、创建GraphQL Schema、配置GraphQL服务等步骤。同时,文章还探讨了常见问题及其解决方法,如处理复杂查询、错误处理、性能优化和实现认证授权等,旨在帮助开发者构建灵活且高效的API。
57 3
|
4月前
|
开发框架 JavaScript 前端开发
一个适用于 ASP.NET Core 的轻量级插件框架
一个适用于 ASP.NET Core 的轻量级插件框架
|
5月前
|
开发框架 前端开发 JavaScript
ASP.NET MVC 教程
ASP.NET 是一个使用 HTML、CSS、JavaScript 和服务器脚本创建网页和网站的开发框架。
67 7
|
5月前
|
存储 开发框架 前端开发
ASP.NET MVC 迅速集成 SignalR
ASP.NET MVC 迅速集成 SignalR
113 0
|
6月前
|
开发框架 前端开发 .NET
ASP.NET MVC WebApi 接口返回 JOSN 日期格式化 date format
ASP.NET MVC WebApi 接口返回 JOSN 日期格式化 date format
84 0

热门文章

最新文章