SpringBoot - 接口文档 knife4j

SpringBoot接入接口文档 knife4j

概述

接口文档和在线调试，原来一直用的Swagger。
Knife4j 是springfox-swagger的增强UI实现，为Java开发者在使用Swagger的时候，能拥有一份简洁、强大的接口文档体验。

组件

Knife4j 官网

依赖

pom.xml：

	<dependency>
        <groupId>com.github.xiaoymingroupId>
        <artifactId>knife4j-spring-boot-starterartifactId>
        
        <version>2.0.2version>
    dependency>

配置

knife4j:
  production: false
  basic:
    ## 开启Swagger的Basic认证功能,默认是false
    enable: true
    ## Basic认证用户名
    username: admin
    ## Basic认证密码
    password: xxx

@Component
@EnableSwagger2
@EnableKnife4j
public class Knife4jConfig {

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                // 分组名称
                .groupName("xxxx").select()
                // 这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.xxx.Controller")).paths(PathSelectors.any()).build();
        return docket;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("xxx RESTful APIs").description("xxx RESTful APIS")
                .termsOfServiceUrl("http://localhost:9090/").contact(new Contact("xxx", "xx", "xxxxx"))
                .version("1.0").build();
    }
}

运行

http://IP:PORT/doc.html 输入配置的用户名和密码