Bootstrap

springboot 整合swagger2 ,搭建 RESTful API 在线文档

1、pom 文件引入jar包

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

2、生成文档的注释

swagger2 通过注解来生成api接口文档,文档信息包括接口名、请求方法、参数、返回信息等。

注解:

@Api

修饰整个类,用于描述Controller类

@ApiOperation

描述类的方法,或者说是一个接口
@ApiParam单个参数描述
@ApiModel用对象来接受参数
@ApiProperty用对象接收参数时,描述对象的一个字段
@ApiResponseHTTP响应的一个描述
@ApiResponsesHTTP响应的整体描述
@ApiIgnore忽略这个api
@ApiError发生错误返回的信息
@ApiParamImplicit一个请求参数
@ApiParamsImplicit多个请求参数

 

;