spring mvc 之 Swagger-api文档生成
1.引入架包
找到maven的仓库http://mvnrepository.com里搜索Springfox
2.选择maven依赖依次添加到Pom.xml文件中
3. 在启动类上添加@EnableSwagger2注解
4. 这个时候启动的时候会访问sawgger地址就会看到
http://localhost:8080/swagger-ui.html
- 通过注解添加api文档的中文说明
1) @Api()用于类;
表示标识这个类是swagger的资源
2) @ApiOperation()用于方法;
表示一个http请求的操作
3) @ApiParam()用于方法,参数,字段说明;
表示对参数的添加元数据(说明或是否必填等)
4) @ApiModel()用于类
表示对类进行说明,用于参数用实体类接收
5) @ApiModelProperty()用于方法,字段
表示对model属性的说明或者数据操作更改
6) @ApiIgnore()用于类,方法,方法参数
表示这个方法或者类被忽略
7) @ApiImplicitParam() 用于方法
表示单独的请求参数
8) @ApiImplicitParams() 用于方法,包含多个 @ApiImplicitParam
使用效果:
@Api()
用于类;表示标识这个类是swagger的资源
tags–表示说明
value–也是说明,可以使用tags替代
但是tags如果有多个值,会生成多个list
@ApiOperation 用于方法;表示一个http请求的操作
value用于方法描述
notes用于提示内容
tags可以重新分组(视情况而用)
@ApiParam用于方法,参数,字段说明;表示对参数的添加元数据(说明或是否必填等)
name–参数名
value–参数说明
required–是否必填
@ApiModelProperty用于方法,字段; 表示对model属性的说明或者数据操作更改
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏