Swagger的介绍网上很多,这里我就不赘述了。简单来说就是一个用于生成Api文档和调试Api接口的框架。
一、Swagger注解
Swagger的使用都是基于注解的,所以在开始使用Swagger之前,我们先来了解一下它有哪些注解。
Swagger的注解大致来说可以分为两类,一类是用于Controller层,就是我们的接口;还有一类是用于Model的,也就是一些POJO类,比如用于接收参数的类呀、返回给前端的类呀这些的。
1、用于Controller层的注解
注解 | 作用范围 | 说明 |
---|---|---|
@Api | 类 | 表明该类是一个接口类 |
@ApiOperation | 方法 | 表名该方法是一个接口 |
@ApiImplicitParam | 方法 | 对方法的参数进行说明 |
@ApiImplicitParams | 方法 | 用于包含多个@ApiImplicitParam |
@ApiParam | 方法的参数上 | 当方法的参数时一个类时,用此注解较 |
2、用于Model的注解
注解 | 作用范围 | 说明 |
---|---|---|
@ApiModel | 类 | 表名该类是一个Model |
@ApiModelProperty | 成员变量 | 对该成员变量进行说明 |
PS:以上注解并不完整,只是较为常用的注解。若想查看所有注解,请到swagger-annotations.jar
这个jar中的io.swagger.annotations
包下查看,我现在是用的1.5.20版本的swagger一共有27个注解。以后用到了新的注解,我会再进行补充。