SpringBoot整合Swagger3之分组问题及解决

Swagger3如果没有设置分组

则所有的API接口全在一个default分组中，

如下所示：

如果功能模块和接口数量逐渐增多时

就会显得有些凌乱，不方便查找和使用，这时可提供的解决方法就是对API接口进行分组，配置多个分组只需要配置多个docket，并通过Swagger实例Docket的groupName()方法定义各个分组名

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class Swagger3Config {

    @Bean
    public Docket createRestApi1() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .groupName("User")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.bc.work.controller.user"))
                .paths(PathSelectors.any())
                .build();
    }

    @Bean
    public Docket createRestApi2() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .groupName("Sys")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.bc.work.controller.sys"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Swagger3接口文档")
                .description("接口文档描述部分")
                .contact(new Contact("bc", "http://www.baidu.com", "[email protected]"))
                .version("1.0版本")
                .build();
    }
}

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持本站。

您可能感兴趣的文章:

• SpringBoot3整合knife4j(swagger3)的详细过程
• SpringBoot整合Swagger3.0全过程
• springboot3.x集成SpringDoc Swagger3过程
• SpringBoot2.6.x 与 Swagger3 兼容问题及解决方法
• SpringBoot3整合Swagger3时出现Type javax.servlet.http.H的ttpServletRequest not present错误解决方法
• SpringBoot集成swagger3.0指南分享
• SpringBoot3使用Swagger3的示例详解