springboot整合swagger2犯过的错

关于这个文档

临近期末考，发现swagger真的很好用（当然考试肯定要用到），自己在学习过程中也不可避免的踩到了一些坑，我在文章的末尾加上了我遇到的坑（其实是自己菜）。所以记录一下。

关于swagger2

swagger是一款让你有更好的书写API文档的框架。在开发新版本或者迭代版本的时候，只需要更新swagger描述文件，就可以自动生成接口文档和客户端服务端代码，做到调用端代码、服务端代码以及接口文档的一致性。

常用的注解如下：

• @Api()用于类名
• @ApiOperation()用于方法名
• @ApiParam()用于参数说明
• @ApiModel()用于实体类
• @ApiModelProperty用于实体类属性

1.新建一个springboot项目。

2.在pom.xml里面导入swagger的依赖

我之前选择的是2.2.2版本，运行后发现会报错，所以我还是选择了2.9.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>

3.新建Controller包，在下面新建一个TestController测试一下。

package zeng.demo.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@Api(value = "计算服务",description="简单的Test，提供加减乘除运算API")
@RestController
@RequestMapping("/Test")
public class TestController {
    @ApiOperation("加法运算")
    @PostMapping("/add")
    public Double add(@RequestParam Double a, @RequestParam Double b) {
        return a + b;
    }
    @ApiOperation("减法运算")
    @PostMapping("/sub")
    public Double sub(@RequestParam Double a,  @RequestParam Double b) {
        return a - b;
    }
    @ApiOperation("乘法运算")
    @PostMapping("/mul")
    public Double mul(@RequestParam Double a,  @RequestParam Double b) {
        return a * b;
    }
    @ApiOperation("除法运算")
    @PostMapping("/div")
    public Double div(@ApiParam("被除数")@RequestParam Double a, @ApiParam("除数")@RequestParam Double b) {
        return a / b;
    }
}

4.新建config包，然后新建一个Swagger2Configuration。

记得要对应正确的路径

package zeng.demo.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;

@Configuration
@EnableSwagger2
public class Swagger2Configuration {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("zeng.demo.controller"))//要扫描的API(Controller)包
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2 UI构建API文档")//标题
                .description("自己随便做的")//描述
                .version("1.0")
                .build();
    }
}

5.运行

运行 http://localhost:8082/swagger-ui.html

举个例子，按下Try it out

输入两个数，点击左下方的Execute。或者右下方的Clear，当然你也可以按cancel取消。

最后的结果：

6.遇到的问题

我的解决措施是

1、检查Swagger2Configuration里面的Controller路径是否正确。

2、把swagger放到可以扫描到的包下。

3、在启动类添加@ComponentScan注解扫描swagger配置类。