Swagger配置 配置knife4j 好看的ui界面_knife ui

Swagger

官方文档

使用

如果不需要knife4j 不要引入他的依赖即可 建议引用

启动类加注解@EnableSwagger2

	很好看的ui界面  推荐使用  两个都可以用 看个人爱好
	访问地址
	doc: 		http://localhost:8088/doc.html
	Swagger: 	http://localhost:8088/swagger-ui.html
1
2
3
4

导入依赖

 <!-- 生成api文档-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
            <exclusions>
                <exclusion>
                    <artifactId>swagger-models</artifactId>
                    <groupId>io.swagger</groupId>
                </exclusion>
            </exclusions>
        </dependency>

        <!-- 可视化接口 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

        <!--在引用时请在maven中央仓库搜索最新版本号-->
        <!--基于swagger二次开发的一个好看的ui界面-->
        <!-- 访问地址 http://localhost:8088/doc.html -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>2.0.2</version>
            <exclusions>
                <exclusion>
                    <artifactId>swagger-annotations</artifactId>
                    <groupId>io.swagger</groupId>
                </exclusion>
            </exclusions>
        </dependency>
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

配置类

package com.initialize.appapi.config;//package com.initialize.appapi.config;

import com.initialize.pub.jwt.util.JwtTokenUtil;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

/**
 * @program: demo
 * @description: Swagger配置类
 * @author: Mr.Lu
 * @create: 2020-06-05 13:56
 **/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {

        //在配置好的配置类中增加此段代码即可
        ParameterBuilder ticketPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<Parameter>();
        ticketPar.name("Authorization").description("令牌")//name表示名称，description表示描述
                .modelRef(new ModelRef("string")).parameterType("header")
                .required(false).defaultValue(JwtTokenUtil.TOKEN_PREFIX).build();//required表示是否必填，defaultvalue表示默认值 /*.defaultValue(TokenUtil.TOKEN_TEST_TOKEN)*/
        pars.add(ticketPar.build());//添加完此处一定要把下边的带***的也加上否则不生效

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
//                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))   //这里采用包含注解的方式来确定要显示的接口
                .apis(RequestHandlerSelectors.basePackage("com.initialize.appapi.controller"))    //这里采用包扫描的方式来确定要显示的接口
//                .apis(RequestHandlerSelectors.basePackage("com.star.dealapi.controller"))    //这里采用包扫描的方式来确定要显示的接口
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars);//************把消息头添加
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("初始化项目")
                .description("Api文档")
                .termsOfServiceUrl("https://gitee.com/My_underwear/initialize_project")
                .version("1.0")
                .contact(new Contact("MyLu", "https://blog.csdn.net/qq_46126559", "chnllcong@gmail.com"))
                .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