From 0bf868d3cdf9226e178c076d3b588ed5207409a0 Mon Sep 17 00:00:00 2001
From: kongzy <kongzy>
Date: 星期五, 24 十一月 2023 17:51:40 +0800
Subject: [PATCH] merge
---
assess-common/src/main/java/com/gkhy/assess/common/config/BaseSwaggerConfig.java | 63 +++++++++++++++++++++++++++++++
1 files changed, 63 insertions(+), 0 deletions(-)
diff --git a/assess-common/src/main/java/com/gkhy/assess/common/config/BaseSwaggerConfig.java b/assess-common/src/main/java/com/gkhy/assess/common/config/BaseSwaggerConfig.java
new file mode 100644
index 0000000..de01f87
--- /dev/null
+++ b/assess-common/src/main/java/com/gkhy/assess/common/config/BaseSwaggerConfig.java
@@ -0,0 +1,63 @@
+package com.gkhy.assess.common.config;
+
+import io.swagger.annotations.ApiOperation;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+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;
+
+/**
+ * Swagger2的接口配置
+ *
+ */
+public class BaseSwaggerConfig
+{
+ /** 是否开启swagger */
+ @Value("${swagger.enabled:false}")
+ private boolean enabled;
+
+ /**
+ * 创建API
+ */
+ @Bean
+ public Docket createRestApi()
+ {
+ return new Docket(DocumentationType.SWAGGER_2)
+ // 是否启用Swagger
+ .enable(enabled)
+ // 用来创建该API的基本信息，展示在文档的页面中（自定义展示的信息）
+ .apiInfo(apiInfo())
+ // 设置哪些接口暴露给Swagger展示
+ .select()
+ // 扫描所有有注解的api，用这种方式更灵活
+ .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
+ // 扫描指定包中的swagger注解
+ //.apis(RequestHandlerSelectors.basePackage("com.ruoyi.project.tool.swagger"))
+ // 扫描所有 .apis(RequestHandlerSelectors.any())
+ .paths(PathSelectors.any())
+ .build();
+ }
+
+ /**
+ * 添加摘要信息
+ */
+ private ApiInfo apiInfo()
+ {
+ // 用ApiInfoBuilder进行定制
+ return new ApiInfoBuilder()
+ // 设置标题
+ .title("xx系统单机版API文档")
+ // 描述
+ .description("描述：xx系统单机版API文档")
+ // 作者信息
+ .contact(new Contact("nms", null, null))
+ // 版本
+ .version("版本号:1.0")
+ .build();
+ }
+}
--
Gitblit v1.9.2