Swagger总结

Swagger总结

Swagger是一个可以帮你自动生成接口文档的工具，并且可以在线对接口进行测试。当然想要让Swagger自动帮你生成接口文档，你需要在项目中使用到Swagger的几个常用注解：

@Api :加在Controller类上面，说明这个Controller的作用

@ApiOperation：加在Controller类里面的每个方法上，说明这个方法的作用

@ApiImplicitParams：加在Controller类的方法上，用来说明一组请求参数的含义

@ApiImplicitParam：也是加在Controller类的方法上，用来说明单个请求参数的含义

@ApiModel：加在用于接收请求参数的JavaBean上面，说明这个JavaBean的含义

@ApiModelProperty：加在JavaBean的每个属性上面，说明每个属性的含义

非要说Swagger的缺点的话，我觉着那就是文档和代码的耦合性太高了，接口文档如果要更新的话，首先需要修改相应的注解，然后再重新启动项目才可以。