feat: 新增项目api文档配置

This commit is contained in:
han0
2023-10-26 10:37:00 +08:00
parent 818d0ab928
commit 2aa2f4049c

View File

@@ -0,0 +1,50 @@
package mjkf.xinke.main.config;
import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import io.swagger.annotations.ApiOperation;
import mjkf.xinke.common.pojo.CommonResult;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RequestMethod;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import javax.annotation.Resource;
@Configuration
public class ApiDocConfig {
@Resource
private OpenApiExtensionResolver openApiExtensionResolver;
/**
* API文档分组配置
*
* @author xuyuxiang
* @date 2022/7/7 16:18
**/
@Bean(value = "mainDocApi")
public Docket sysDocApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(new ApiInfoBuilder()
.title("系统功能MAIN")
.description("系统功能MAIN")
.termsOfServiceUrl("")
.contact(new Contact("","", ""))
.version("2.0.0")
.build())
.globalResponseMessage(RequestMethod.GET, CommonResult.responseList())
.globalResponseMessage(RequestMethod.POST, CommonResult.responseList())
.groupName("系统功能MAIN")
.select()
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.apis(RequestHandlerSelectors.basePackage("mjkf.xinke.main"))
.paths(PathSelectors.any())
.build().extensions(openApiExtensionResolver.buildExtensions("系统功能MAIN"));
}
}