经大佬指正,Swagger属于中间件的一种,可以理解为是一种插件类型的服务,不一定适配兼容的完美。
在Springboot课中看到了swagger2+springboot的整合,正好自己又在尝试自己的第一个RESTful项目,看到了swagger的介绍我就动心了,我毕竟以懒闻名。记得有一次写后端就因为接口改的太慢被前端同学挤兑,唉,看到了自动化的API+UI工具不由得激动了就试了一下,虽然还有问题没有解决(可能是没有找到最佳实践),但先把基础用法整理出来。
POM
POM依赖
配置类
配置类
这里整理一下,大概注解
@Api 用于 Controller 类上
@ApiOperation 用在 Controller 的方法上
@ApiImplicitParams 用在 Controller 的方法上
@ApiImplicitParam 用在 @ApiImplicitParams 的方法里边
@ApiResponses 用在 Controller 的方法上
@ApiResponse 用在 @ApiResponses 里边
Controller代码
Controller代码
然后访问项目地址 /swagger-ui.html 就出来啦
成型图
目前遇到的问题就是,自己写的项目里头都是对返回结果统一进行了封装的,比如JSONResult类,这个类中放的参数类型可能多种多样,所以泛型没办法统一指定。但是不再APImodel注解类中进行指定的话,API这边返回的数据类型即使在Controller里头写好了,也没办法显示出来详细的信息,就会产生没办法展示详细响应数据的问题。见图,望大佬指点!
问题
网友评论