Knife4j Spring Boot：在线API文档

1.导入依赖

        <dependency>
            <groupId>com.github.xiaoymingroupId>
            <artifactId>knife4j-spring-boot-starterartifactId>
            <version>${knife4j-spring-boot.version}version>
        dependency>


1
2
3
4
5
6
7

2.再配置文件中打开日志

	knife4j.enable=true
1

3.写配置文件

package com.example.studytest.config;
import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
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;/**
/**
 * 上面的java提供参考
 * Knife4j配置类
 *
 * @author 
 * @version 2.0
 */
@Slf4j
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

        /**
         * 【重要】指定Controller包路径
         */
        private static final String BASE_PACKAGE = "com.example";
        /**
         * 组名
         */
        private static final String GROUP_NAME = "学习测试";
        /**
         * 主机名
         */
        private static final String HOST = "http://localhost";
        /**
         * 标题
         */
        private static final String TITLE = "学习测试-在线API文档";
        /**
         * 简介
         */
        private static final String DESCRIPTION = "学习测试-在线API文档";
        /**
         * 服务条款URL
         */
        private static final String TERMS_OF_SERVICE_URL = "http://www.apache.org/licenses/LICENSE-2.0";
        /**
         * 联系人
         */
        private static final String CONTACT_NAME = "学习测试";
        /**
         * 联系网址
         */
        private static final String CONTACT_URL = "http://www.baipiaozhong.com";
        /**
         * 联系邮箱
         */
        private static final String CONTACT_EMAIL = "helloxiaoxiaobai@163.com";
        /**
         * 版本号
         */
        private static final String VERSION = "2.0";

        @Autowired
        private OpenApiExtensionResolver openApiExtensionResolver;

        public Knife4jConfiguration() {
                log.debug("创建配置类对象：Knife4jConfiguration");
        }

        @Bean
        public Docket docket() {
                return new Docket(DocumentationType.SWAGGER_2)
                        .host(HOST)
                        .apiInfo(apiInfo())
                        .groupName(GROUP_NAME)
                        .select()
                        .apis(RequestHandlerSelectors.basePackage(BASE_PACKAGE))
                        .paths(PathSelectors.any())
                        .build()
                        .extensions(openApiExtensionResolver.buildExtensions(GROUP_NAME));
        }

        private ApiInfo apiInfo() {
                return new ApiInfoBuilder()
                        .title(TITLE)
                        .description(DESCRIPTION)
                        .termsOfServiceUrl(TERMS_OF_SERVICE_URL)
                        .contact(new Contact(CONTACT_NAME, CONTACT_URL, CONTACT_EMAIL))
                        .version(VERSION)
                        .build();
        }

}


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

4.成功运行。