swagger-bootstrap-ui_com.github.xiaoymin swagger-bootstrap-ui

swagger boot Strap UI使用

首先配置swagger2

maven依赖：

 				<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
1
2
3
4
5

使用原生swagger2页面要导入：

 				<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
1
2
3
4
5

访问地址：localhost:80/swagger-ui.html

使用增强版导入依赖：

				<dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>
1
2
3
4
5

即可通过localhost:80/doc.html访问到新的页面；

该依赖可使用：

1. @ApiSort(value = 1)//为接口文件排序
   1

2. @ApiOperationSupport(order = 1)//接口中的方法排序
   1

如果添加了knife4j会导致swagger2展示错误冲突

        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
        </dependency>
1
2
3
4

使用spring-boot-web 重的依赖即可。

swagger2配置：

package com.zero.earth.applet;

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
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.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;


@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI//增强版swagger2需要配置此注解
@Profile({"dev"})//通过配置文件判断是否可以访问
public class Swagger2 implements WebMvcConfigurer {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(true)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zero.earth.applet"))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(getParameter());

    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("APi")
                .description("<h2>介绍：</h2>")
                .version("1.0.0")
                .build();
    }
    /**
     * swagger 增加header参数
     * @return
     */
    private List<Parameter> getParameter() {
        List<Parameter> parameters = new ArrayList<>();
        ParameterBuilder token = new ParameterBuilder();
        token.name("token").defaultValue("").description("登录认证")
                .modelRef(new ModelRef("string"))
                .parameterType("header").required(true)
                .build();
        parameters.add(token.build());

        return parameters;
    }
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**")
                .addResourceLocations("classpath:/static/");

        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");

    }
}

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

配置SwaggerBootstrapUiApplication：

package com.zero.earth.applet;

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.annotation.Profile;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import springfox.documentation.spring.web.SpringfoxWebMvcConfiguration;

@SpringBootApplication
@Profile({"dev"})
@ConditionalOnClass(SpringfoxWebMvcConfiguration.class)
public class SwaggerBootstrapUiApplication implements WebMvcConfigurer {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

今天配置的时候访问swagger-ui.html一直404 就是因为knife4j配置依赖导致的。并且把swagger的依赖写到了dependencyManagement中导致的错误。

认真细心，莫要心机！