1、简介
Swagger是为了解决企业中接口(api)中定义统一标准规范的文档生成工具。很多采用前后端分离的模式,前端只负责调用接口,进行渲染,前端和后端的唯一联系,变成了API接口。因此,API文档变得越来越重要。swagger是一个方便我们更好的编写API文档的框架,而且swagger可以模拟http请求调用。
2、常用注解与示例
@Api()用于类:表示标识这个类是swagger的资源;
@ApiOperation()用于方法:表示一个http请求的操作;;
@ApiParam():用于方法,参数,字段说明:表示对参数的添加元数据(说明或是否必填等);
@ApiModel()用于类:表示对类进行说明,用于参数用实体类接收;
@ApiModelProperty()用于方法,字段:表示对model属性的说明或者是数据操作更改;
@ApiIgnore()用于类,方法,方法参数:表示这个方法或者类被忽略;
@ApiImplicitParam()用于方法:表示单独的请求参数
@ApiImplicitParams()用于方法,包含多个@ApiImplicitParam