Swagger 是一套基于 OpenAPI 规范（OpenAPI Specification，OAS）构建的开源工具， 提供了一套通过代码和注解自动生成文档的方法，可以帮助我们设计、构建、记录以及使用 Restful API。

1.pom.xml中添加Swagger3依赖

 <!--swagger3-->
<dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-boot-starter</artifactId>
     <version>3.0.0</version>
 </dependency>

2. 主程序启动类添加@EnableOpenApi注解

@SpringBootApplication
@EnableOpenApi
public class ****Application {
    public static void main(String[] args) {
        SpringApplication.run(****Application.class, args);
    }
}

3 配置类

@Configuration
public class SwaggerConfig {
    Boolean swaggerEnabled=true;
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30).apiInfo(apiInfo())
                // 是否开启
                .enable(swaggerEnabled).select()
                // 扫描的路径包
                .apis(RequestHandlerSelectors.basePackage("controller所在包"))
                // 指定路径处理PathSelectors.any()代表所有的路径
                .paths(PathSelectors.any()).build().pathMapping("/");
    }

    private ApiInfo apiInfo() {
        Calendar c = Calendar.getInstance(TimeZone.getTimeZone("GMT+08:00"));    //获取东八区时间
        SimpleDateFormat s = new SimpleDateFormat("yyyy-MM-dd");
        String curDate = s.format(c.getTime());
        return new ApiInfoBuilder()
                .title("项目API文档")
                .description(curDate + " 发布")
                .version("V1.0")
                .build();
    }
}

4. 文档地址

https://ip:port/context-path/swagger-ui/index.html