一、配置步骤

1.在pom.xml中添加依赖

方式一：只需要添加knife4j-starter 即可

   <!-- knife4j（swagger）依赖 -->
   <dependency>
       <groupId>com.github.xiaoymin</groupId>
       <artifactId>knife4j-spring-boot-starter</artifactId>
       <version>3.0.0</version>
   </dependency>

方式二：添加swagger2依赖

	<!--swagger2 start依赖 -->
	<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.创建Swagger2 的配置类

代码如下：

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		//作用是自动开启swagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())		// 指定构建api文档的详细信息的方法：apiInfo()
                .select()
                // 指定要生成api接口的包路径
                .apis(RequestHandlerSelectors.basePackage("com.demo.swagger.controller"))
                //使用了 @ApiOperation 注解的方法，才生成api接口文档
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();	//可以根据url路径设置哪些请求加入文档，忽略哪些请求
    }

    /**
     * 设置api文档的详细信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 标题
                .title("Swagger2 接口文档")
                // 接口描述
                .description("swagger接口文档")
                // 联系方式
                .contact("冰雪伯爵")
                // 版本信息
                .version("1.0.0")
                // 构建
                .build();
    }
}

3. controller 测试

在controller中增加注解@API，方法上增加注解@ApiOperation，参数前加@ApiParam
代码如下：

@RestController
@RequestMapping(value = "/swagger")
@Api(tags = "测试swagger")
public class TestController {
    
    @PostMapping("/test")
    @ApiOperation(value = "swagger测试")
    public String test(@RequestParam("id") Integer id){
        return "swagger:"+id;
    }
}