swagger 响应 自定义怎么写
Posted
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了swagger 响应 自定义怎么写相关的知识，希望对你有一定的参考价值。
参考技术A 从此接口文档成为一笑而过，从此服务端不再被客户端追债似得要接口文档 主要内容： 1、项目背景 2、Swagger应用 3、总结 项目背景 作为一个服务端开发人员，我相信大多数的同学都会和客户端开发同学沟通接口问题本回答被提问者采纳Swagger自定义文档插件
参考技术A 在原有文档的基础上, 丰富或更改文档的信息 , 例如在 @ApiOperation 中自动添加权限码的说明, 那么可以通过Swagger的 OperationBuilderPlugin 插件来实现自定义的插件Bean加载, 优先级要迟于Swagger自带的插件, 否则文档中的值会被覆盖, 如被自带的notes解析类覆盖 OperationNotesReader
如果需要更复杂的操作, 如根据方法和类上的信息更改Swagger文档, 不是必须的视情况而定
输入文档地址 http://localhost:8080/swagger-ui.html , 由图可知权限码已自动添加到文档的描述中
实现的方案有多种(任意一种均可), 可以覆盖原有的文档相关的类, 可以加入web的拦截器; 主要是分享一下思路, 具体的流程可以去debug查看 SpringFox源码
页面的请求 (Swagger2ControllerWebMvc) 最终会落到 DocumentationCache , 所以在文档缓存添加的时候, 用反射更改文档字段的信息
以上是关于swagger 响应 自定义怎么写的主要内容，如果未能解决你的问题，请参考以下文章