Swagger 接口分组

叁歲伎倆 2024-03-22 20:36 51阅读 0赞

在项目中接口很多，还包括子模块的，使用swagger调试接口的时候，没有分组的话，就变成查找。这时候，要添加分组。

### Bean处理：添加@Bean ###

@EnableSwagger2
    @Configuration
    public class SwaggerConfig implements BeanFactoryPostProcessor {  
        @Bean
        public Docket restApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .groupName("standard")
                    .apiInfo(apiInfo("Spring Boot中使用Swagger2构建RESTful APIs", "1.0"))
                    .useDefaultResponseMessages(true)
                    .forCodeGeneration(false)
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.example.learning.controller"))
                    .paths(PathSelectors.regex("/api.*"))
                    .build();
        }
    
        @Bean
        public Docket restApi2() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .groupName("其他接口")
                    .apiInfo(apiInfo("Other APIs", "2.0"))
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.example.learning.other"))
                    .paths(PathSelectors.regex("/other.*"))
                    .build();
        }
    }
    
    
        /**
         * @return
         */
        private ApiInfo apiInfo(String title, String version) {
            return new ApiInfoBuilder().title(title).description(version).termsOfServiceUrl("").version("1.0.0")
                    .build();
        }

### postProcessBeanFactory的处理 ###

@EnableSwagger2
    @Configuration
    public class SwaggerConfig implements BeanFactoryPostProcessor {
    
        private Map<String, String> apiGroupMap = new HashMap<String, String>() {
            {
                put("main", "com.example.learning.controller");
                put("other", "com.example.learning.other");
            }
        };
    
        public Docket createApi(String groupName, String basePackage) {
            return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).groupName(groupName).select()
                    .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).paths(PathSelectors.any())
                    .apis(RequestHandlerSelectors.basePackage(basePackage)).build();
        }
    
        /**
         * @return
         */
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder().title("API").description("API文档").termsOfServiceUrl("").version("1.0.0")
                    .build();
        }
    
        @Override
        public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
            for (Map.Entry<String, String> e : apiGroupMap.entrySet()) {
                beanFactory.registerSingleton("docket" + e.getKey(), createApi(e.getKey(), e.getValue()));
            }
        }
    }

**swagger 访问地址**

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

context-path: 是 yml配置的地址。如果未设置就为http://ip:port/swagger-ui/index.html

server:
      port: 8088
      servlet:
        context-path: /api/v1/study

### 总结： ###

使用第二种会更方便些，直接根据package的路径去设置，也更为清晰。