Swagger自定义文档插件
Posted
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Swagger自定义文档插件相关的知识，希望对你有一定的参考价值。
参考技术A 在原有文档的基础上, 丰富或更改文档的信息 , 例如在 @ApiOperation 中自动添加权限码的说明, 那么可以通过Swagger的 OperationBuilderPlugin 插件来实现自定义的插件Bean加载, 优先级要迟于Swagger自带的插件, 否则文档中的值会被覆盖, 如被自带的notes解析类覆盖 OperationNotesReader
如果需要更复杂的操作, 如根据方法和类上的信息更改Swagger文档, 不是必须的视情况而定
输入文档地址 http://localhost:8080/swagger-ui.html , 由图可知权限码已自动添加到文档的描述中
实现的方案有多种(任意一种均可), 可以覆盖原有的文档相关的类, 可以加入web的拦截器; 主要是分享一下思路, 具体的流程可以去debug查看 SpringFox源码
页面的请求 (Swagger2ControllerWebMvc) 最终会落到 DocumentationCache , 所以在文档缓存添加的时候, 用反射更改文档字段的信息
以上是关于Swagger自定义文档插件的主要内容，如果未能解决你的问题，请参考以下文章
自定义SpringBoot+Swagger中@ApiModel默认名称
.NET Core基础篇之：集成Swagger文档与自定义Swagger UI
Swagger2自定义添加请求头key-value暴力猴插件