spring boot集成swagger

参考：https://www.jianshu.com/p/dcaff30f91cc?tdsourcetag=s_pctim_aiomsg

1.什么是swagger？

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。一个可视化的管理接口的页面，并且可以导出接口文档。

2.spring boot集成swagger

2.1 新建spring boot项目

访问：https://start.spring.io/

快速构建一个spring boot项目，搜索web依赖选择spring web

 使用idea导入下载的demo-swagger项目。

2.2 swagger依赖

<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>

2.3 配置swagger

package com.example.demoswagger.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * className: Swagger <br/>
 * packageName:com.example.demoswagger.config <br/>
 *
 * @author yuwen <br/>
 * @date: 2019-11-9 14:37 <br/>
 */
@Configuration
@EnableSwagger2
public class Swagger {

    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     *
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demoswagger.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://项目实际地址/swagger-ui.html
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("测试 APIs")
                .description("测试api接口文档")
                .termsOfServiceUrl("http://www.baidu.com")
                .version("1.0")
                .build();
    }

}

2.4 新建一个controller

package com.example.demoswagger.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

/**
 * className: IndexController <br/>
 * packageName:com.example.demoswagger.controller <br/>
 *
 * @author yuwen <br/>
 * @date: 2019-11-9 14:38 <br/>
 */

@RestController("/index")
@Api(tags = {"测试接口"})
public class IndexController {

    @GetMapping("/test")
    @ApiOperation("输入信息")
    public ResponseEntity testSwagger(@RequestParam("msg") String msg) {
        return new ResponseEntity(msg, HttpStatus.OK);
    }
}

2.5 测试

启动项目，访问：http://127.0.0.1:8080/swagger-ui.html

出现以下即为成功：

3.附录：swagger的常用注解

@Api：用在类上，说明该类的作用。

@ApiOperation：注解来给API增加方法说明。

@ApiModelProperty：用在接口入参dto类的属性上，表名这属性的含义，在页面中可以体现