SpringBoot——》整合knife4j详细步骤

推荐：
总结——》【SpringBoot】

一、在maven项目的pom.xml中引入Knife4j的依赖包

1、Knife4j本身已经引入了springfox，不用再单独引入Springfox的具体版本，否则会导致版本冲突。
2、使用Knife4j2.0.6及以上的版本，Spring Boot的版本必须大于等于2.2.x

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <!--在引用时请在maven中央仓库搜索2.X最新版本号-->
    <version>2.0.8</version>
</dependency>

二、创建Swagger配置依赖

import io.swagger.annotations.ApiOperation;
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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

@Configuration
@EnableSwagger2WebMvc
public class Swagger {

    @Bean(value = "defaultApi")
    public Docket defaultApi() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //分组名称
                .groupName("2.X版本")
                .select()
                //这里指定Controller扫描包路径
//                .apis(RequestHandlerSelectors.basePackage("com.github.xiaoymin.knife4j.controller"))
                //这里指定扫描有ApiOperation注解的类
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                //所有路径
                .paths(PathSelectors.any())
                //不包含^/inner/.*的路径
                //.paths(input -> !input.matches("^/inner/.*"))
                .build();
        return docket;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("小仙的RESTful APIs")
                .description("构建RESTful APIs")
                .termsOfServiceUrl("https://blog.csdn.net/weixin_43453386")
                .contact(new Contact("小仙",
                        "https://blog.csdn.net/weixin_43453386",
                        "xxx@163.com"))
                .version("1.0")
                .build();
    }
}

三、启动SpringBoot工程

在浏览器中访问，http://127.0.0.1:8080/doc.html

四、新建TestController.java并测试

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

@RestController
@Api(value = "测试controller")
public class TestController {

    @ApiImplicitParam(name = "name", value = "姓名", required = true)
    @ApiOperation(value = "欢迎光临")
    @GetMapping("/welcome")
    public ResponseEntity<String> welcome(@RequestParam(value = "name") String name) {
        return ResponseEntity.ok(name + "，终于等到你~\\(≧▽≦)/~啦啦啦");
    }
}

在doc.html中可以看到新建的api文档：

输入参数，直接点击发送，进行测试：