SpringBoot - SWAGGER3公共模块的抽象集成与使用(三)

原创

已于 2022-06-30 18:21:59 修改 · 693 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #swagger

于 2022-06-30 18:20:31 首次发布

本文档详细介绍了如何在SpringBoot项目中集成Swagger3，包括创建独立模块、引入依赖、自定义注解、配置自动装配、配置对象、设置加载策略、处理不兼容问题等步骤。最后展示了在线API文档的访问方式和Swagger3资源映射路径。通过这些步骤，开发者可以便捷地为微服务添加API文档功能。

写在前面

用于集成SWAGGER3。
SpringBoot - Swagger2的集成与使用(一)
SpringBoot - SWAGGER2公共模块的抽象集成与使用(二)

操作步骤

1. 创建一个单独的模块(servicex-common-swagger3)

2. 在该模块中引入依赖

<!-- Swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
</dependency>

3. 自定义SWAGGER3注解

4. 创建自动装配SWAGGER3的对象

/**
 * 自动装配SWAGGER3
 * @author ROCKY
 */

@Configuration
@EnableOpenApi
@EnableAutoConfiguration
@ConditionalOnProperty(name = "swagger.enabled", matchIfMissing = true)
public class SwaggerAutoConfiguration {
   
   

    // 默认的排除路径, 排除SPRING BOOT默认的错误处理路径和端点
    private static final List<String> DEFAULT_EXCLUDE_PATH = Arrays.asList("/error", "/actuator/**");

    private static final String BASE_PATH = "/**";

    @Bean
    @ConditionalOnMissingBean
    public SwaggerProperties swaggerProperties() {
   
   
        return new SwaggerProperties();
    }

    @Bean
    public Docket api(SwaggerProperties swaggerProperties) {
   
   
        // BASE-PATH的处理
        if (swaggerProperties.getBasePath().isEmpty()) {
   
   
            swaggerProperties.getBasePath().add(BASE_PATH);
        }
        // SWAGGER会解析的URL规则的处理, 将配置的需要解析的URL规则放进LIST中
        List<Predicate<String>> basePath = new ArrayList<Predicate<String>>();
        swaggerProperties.getBasePath().