搭建 Restful API 在线文档
利用 Swagger2 很容易构建 RESTful 风格的 API

引入依赖

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

// 表明是一个配置类
@Configuration

// 开启 Swagger2 功能
@EnableSwagger2

在配置类中,需要注入一个 Docket 的 Bean 该 Bean 中包含了 apiInfo
即 API 文档的描述信息,以及包扫描的基本包名等信息。

// 注意
.apis(RequestHandlerSelectors.basePackage("controller类所在的包的路径"))

// ApiOperation 注解描述生成在线文档的具体 API 说明。
@ApiOperation

// ApiIgnore 注解是,不需要生成某接口生成文档的时候加上
@ApiIgnore

UI 地址:
http://localhost:8080/swagger-ui.html