Swagger

Swagger

介绍

使用Swagger你只需要按照它的规范去定义接口及接口相关的信息，再通过Swagger衍生出来的一系列项目和工具，就可以做到生成各种格式的接口文档，以及在线接口调试页面等等。
官网：https://swagger.io/
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案。

使用

依赖

        <dependency>
            <groupId>com.github.xiaoymingroupId>
            <artifactId>knife4j-spring-boot-starterartifactId>
            <version>3.0.2version>
        dependency>
1
2
3
4
5

配置配置类

在WebMVCConfig类上加上如下注解

@EnableSwagger2
@EnableKnife4j
1
2

在WebMVCConfig中加入如下方法

    @Bean
    public Docket createRestApi() {
        // 文档类型
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xiyumobai.reggie.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("xxx")
                .version("1.0")
                .description("xx接口文档")
                .build();
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

在LoginCheckFilter中设置不需要处理的路径

                "/doc.html",
                "/webjars/**",
                "/swagger-resources",
                "/v2/api-docs"
1
2
3
4

常用注解