Swagger测试 - 生成swagger文档

1. pom文件中添加依赖

<!--springfox swagger官方Starter 获取API文档时使用-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-ui</artifactId>
    <version>2.0.4</version>
</dependency>
<!--springfox swagger官方Starter 获取API文档时使用-->

2. 配置类

主要用于指定需要扫描的包

@EnableSwagger2
@Configuration
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径,控制器类包
                .apis(RequestHandlerSelectors.basePackage("activiti.core.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("Ngsoc平台API接口文档")
                //版本号
                .version("v2")
                //描述
                .description("系统API描述")
                .build();
    }
}

3. 放开白名单的干扰

ngsoc:
  white-urls:
    - /swagger-ui/index.html
    - /webjars/**
    - /v2/**
    - /swagger-resources/**
    - /swagger-ui/**
    - /*/api-docs
    - /ngsoc/AUTH/doc.html/**
    - /druid/*
    - /api/v1/dev/*
    - /api/v1/set-cookie-and-redirect
    - /doc.html/**
    - /doc.html

或者

ngsoc:
  white-urls:
    - /**

4. 访问

服务器+端口+contextPath+doc.html

http://10.32.39.73:8081/ngsoc/AUTH/doc.html