最近由于公司有一个单体的项目存在大量的接口,集成swagger后发现渲染接口文档界面相当慢,而且接口杂乱无章,不易于前端人员分辨联调。
即使渲染出来,点击查看接口的时候也会存在卡顿情况,swagger默认情况下把所有接口放在一起。
优化方案
在实际生产环境中,为了方便辨认接口,可以进行swagger分组,即定义多个Docket对象。
package com.xxx.common.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
package com.xxx.common.config;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
*
* @EnableSwagger2:开启Swagger2功能
* @Configuration:配置类
*/
@EnableSwagger2
@Configuration
public class SwaggerConfig {
@Bean
public Docket api(){
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.xxx1.controller"))
.paths(PathSelectors.any())
.build()
.groupName("代理商")
.apiInfo(apiInfo());
}
@Bean
public Docket api2(){
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.xxx2.controller"))
.paths(PathSelectors.any())
.build()
.groupName("业务开通控制层")
.apiInfo(apiInfo());
}
private ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("项目接口文档")
.description("项目接口")
.version("1.0.0")
.termsOfServiceUrl("")
.license("")
.licenseUrl("")
.build();
}
}
最终效果如下