张家港网站建设制作,wap网站和app的区别,wordpress主题免刷新,icp备案和icp许可证区别Swagger 是个好东西#xff0c;对于前后端分离的网站来说#xff0c;不仅是提高前后端开发人员沟通效率的利器#xff0c;也大大方便了后端人员测试 API。有时候#xff0c;API 中可能需要在 Header 中设置认证参数#xff0c;比如 authToken#xff0c;这样的功能我们通… Swagger 是个好东西对于前后端分离的网站来说不仅是提高前后端开发人员沟通效率的利器也大大方便了后端人员测试 API。有时候API 中可能需要在 Header 中设置认证参数比如 authToken这样的功能我们通常是使用 ActionFilter 实现的这就会导致 swagger UI 中缺少 authToken 字段下面就来介绍解决这个问题的办法。 创建一个过滤器类内容如下 /// summary/// this class is for swagger to generate AuthToken Header filed on swagger UI/// /summarypublic class AddAuthTokenHeaderParameter : IOperationFilter{ public void Apply(Operation operation, OperationFilterContext context) { if (operation.Parameters null) operation.Parameters new ListIParameter(); var attrs context.ApiDescription.GetActionAttributes(); foreach (var attr in attrs) { // 如果 Attribute 是我们自定义的验证过滤器 if (attr.GetType() typeof(Auth)) { operation.Parameters.Add(new NonBodyParameter() { Name AuthToken, In header, Type string, Required false }); } } } } 然后在配置 Swagger 的地方做一些修改 services.AddSwaggerGen(c { c.SingleApiVersion(new Info(){ Version v1, Title API 文档, Description 系统的 API 文档}); c.OperationFilterAddAuthTokenHeaderParameter(); // 手动高亮}); 最后dotnet run frameborder0 scrollingno stylefont-family: inherit; border-width: initial; border-style: none; font-style: inherit; font-variant: inherit; font-weight: inherit; font-stretch: inherit; font-size: inherit; line-height: inherit; vertical-align: baseline; width: 835px; height: 257px; 这样Swagger UI 中就显示了附加在 header 中的参数——AuthToken还要啥 Postman。 相关文章: 在ASP.NET Core Web API上使用Swagger提供API文档用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档 原文地址http://www.cnblogs.com/JacZhu/p/6188968.html .NET社区新闻深度好文微信中搜索dotNET跨平台或扫描二维码关注
