From eb12d7bd73d9c01ddab47b97ac64a2d5621cf4f8 Mon Sep 17 00:00:00 2001
From: 疯狂的狮子li <15040126243@163.com>
Date: 星期二, 18 五月 2021 11:38:17 +0800
Subject: [PATCH] fix 修复swagger开关无法控制关闭问题
---
ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java | 169 ++++++++++++++++++------------------------
ruoyi-framework/src/main/java/com/ruoyi/framework/config/properties/SwaggerProperties.java | 25 ++++++
.editorconfig | 21 +++++
ruoyi-admin/src/main/resources/application.yml | 7 +
4 files changed, 124 insertions(+), 98 deletions(-)
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..8cfd370
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,21 @@
+# http://editorconfig.org
+root = true
+
+# 绌烘牸鏇夸唬Tab缂╄繘鍦ㄥ悇绉嶇紪杈戝伐鍏蜂笅鏁堟灉涓�鑷�
+[*]
+indent_style = space
+indent_size = 4
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.java]
+indent_style = tab
+
+[*.{json,yml}]
+indent_size = 2
+
+[*.md]
+insert_final_newline = false
+trim_trailing_whitespace = false
diff --git a/ruoyi-admin/src/main/resources/application.yml b/ruoyi-admin/src/main/resources/application.yml
index d072872..b034d99 100644
--- a/ruoyi-admin/src/main/resources/application.yml
+++ b/ruoyi-admin/src/main/resources/application.yml
@@ -193,6 +193,11 @@
description: '鎻忚堪锛氱敤浜庣鐞嗛泦鍥㈡棗涓嬪叕鍙哥殑浜哄憳淇℃伅,鍏蜂綋鍖呮嫭XXX,XXX妯″潡...'
# 鐗堟湰
version: '鐗堟湰鍙�: ${ruoyi-vue-plus.version}'
+ # 浣滆�呬俊鎭�
+ contact:
+ name: Lion Li
+ email: crazylionli@163.com
+ url: https://gitee.com/JavaLionLi/RuoYi-Vue-Plus
# 闃叉XSS鏀诲嚮
xss:
@@ -295,4 +300,4 @@
include: '*'
endpoint:
logfile:
- external-file: ./logs/sys-console.log
\ No newline at end of file
+ external-file: ./logs/sys-console.log
diff --git a/ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java b/ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java
index 8b43f17..92e3976 100644
--- a/ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java
+++ b/ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java
@@ -1,12 +1,9 @@
package com.ruoyi.framework.config;
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
-import com.ruoyi.common.config.RuoYiConfig;
+import com.ruoyi.framework.config.properties.SwaggerProperties;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.beans.factory.annotation.Value;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
@@ -29,103 +26,83 @@
@Configuration
@EnableSwagger2
@EnableKnife4j
-@ConditionalOnClass({Docket.class, ApiInfoBuilder.class})
-@ConditionalOnProperty(prefix = "swagger", value = "enable", matchIfMissing = true)
public class SwaggerConfig {
- /**
- * 绯荤粺鍩虹閰嶇疆
- */
- @Autowired
- private RuoYiConfig ruoyiConfig;
- /**
- * 鏍囬
- */
- @Value("${swagger.title}")
- private String title;
+ @Autowired
+ private SwaggerProperties swaggerProperties;
- /**
- * 鎻忚堪
- */
- @Value("${swagger.description}")
- private String description;
+ /**
+ * 鍒涘缓API
+ */
+ @Bean
+ public Docket createRestApi() {
+ return new Docket(DocumentationType.SWAGGER_2)
+ .enable(swaggerProperties.getEnabled())
+ // 鐢ㄦ潵鍒涘缓璇PI鐨勫熀鏈俊鎭紝灞曠ず鍦ㄦ枃妗ｇ殑椤甸潰涓紙鑷畾涔夊睍绀虹殑淇℃伅锛�
+ .apiInfo(apiInfo())
+ // 璁剧疆鍝簺鎺ュ彛鏆撮湶缁橲wagger灞曠ず
+ .select()
+ // 鎵弿鎵�鏈夋湁娉ㄨВ鐨刟pi锛岀敤杩欑鏂瑰紡鏇寸伒娲�
+ .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
+ // 鎵弿鎸囧畾鍖呬腑鐨剆wagger娉ㄨВ
+ // .apis(RequestHandlerSelectors.basePackage("com.ruoyi.project.tool.swagger"))
+ // 鎵弿鎵�鏈� .apis(RequestHandlerSelectors.any())
+ .paths(PathSelectors.any())
+ .build()
+ /* 璁剧疆瀹夊叏妯″紡锛宻wagger鍙互璁剧疆璁块棶token */
+ .securitySchemes(securitySchemes())
+ .securityContexts(securityContexts());
+ }
- /**
- * 鐗堟湰
- */
- @Value("${swagger.version}")
- private String version;
+ /**
+ * 瀹夊叏妯″紡锛岃繖閲屾寚瀹歵oken閫氳繃Authorization澶磋姹傚ご浼犻��
+ */
+ private List<SecurityScheme> securitySchemes() {
+ List<SecurityScheme> apiKeyList = new ArrayList<SecurityScheme>();
+ apiKeyList.add(new ApiKey("Authorization", "Authorization", "header"));
+ return apiKeyList;
+ }
- /**
- * 鍒涘缓API
- */
- @Bean
- public Docket createRestApi() {
- return new Docket(DocumentationType.SWAGGER_2)
- // 鐢ㄦ潵鍒涘缓璇PI鐨勫熀鏈俊鎭紝灞曠ず鍦ㄦ枃妗ｇ殑椤甸潰涓紙鑷畾涔夊睍绀虹殑淇℃伅锛�
- .apiInfo(apiInfo())
- // 璁剧疆鍝簺鎺ュ彛鏆撮湶缁橲wagger灞曠ず
- .select()
- // 鎵弿鎵�鏈夋湁娉ㄨВ鐨刟pi锛岀敤杩欑鏂瑰紡鏇寸伒娲�
- .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
- // 鎵弿鎸囧畾鍖呬腑鐨剆wagger娉ㄨВ
- // .apis(RequestHandlerSelectors.basePackage("com.ruoyi.project.tool.swagger"))
- // 鎵弿鎵�鏈� .apis(RequestHandlerSelectors.any())
- .paths(PathSelectors.any())
- .build()
- /* 璁剧疆瀹夊叏妯″紡锛宻wagger鍙互璁剧疆璁块棶token */
- .securitySchemes(securitySchemes())
- .securityContexts(securityContexts());
- }
+ /**
+ * 瀹夊叏涓婁笅鏂�
+ */
+ private List<SecurityContext> securityContexts() {
+ List<SecurityContext> securityContexts = new ArrayList<>();
+ securityContexts.add(
+ SecurityContext.builder()
+ .securityReferences(defaultAuth())
+ .forPaths(PathSelectors.regex("^(?!auth).*$"))
+ .build());
+ return securityContexts;
+ }
- /**
- * 瀹夊叏妯″紡锛岃繖閲屾寚瀹歵oken閫氳繃Authorization澶磋姹傚ご浼犻��
- */
- private List<SecurityScheme> securitySchemes() {
- List<SecurityScheme> apiKeyList = new ArrayList<SecurityScheme>();
- apiKeyList.add(new ApiKey("Authorization", "Authorization", "header"));
- return apiKeyList;
- }
+ /**
+ * 榛樿鐨勫畨鍏ㄤ笂寮曠敤
+ */
+ private List<SecurityReference> defaultAuth() {
+ AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
+ AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
+ authorizationScopes[0] = authorizationScope;
+ List<SecurityReference> securityReferences = new ArrayList<>();
+ securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
+ return securityReferences;
+ }
- /**
- * 瀹夊叏涓婁笅鏂�
- */
- private List<SecurityContext> securityContexts() {
- List<SecurityContext> securityContexts = new ArrayList<>();
- securityContexts.add(
- SecurityContext.builder()
- .securityReferences(defaultAuth())
- .forPaths(PathSelectors.regex("^(?!auth).*$"))
- .build());
- return securityContexts;
- }
-
- /**
- * 榛樿鐨勫畨鍏ㄤ笂寮曠敤
- */
- private List<SecurityReference> defaultAuth() {
- AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
- AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
- authorizationScopes[0] = authorizationScope;
- List<SecurityReference> securityReferences = new ArrayList<>();
- securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
- return securityReferences;
- }
-
- /**
- * 娣诲姞鎽樿淇℃伅
- */
- private ApiInfo apiInfo() {
- // 鐢ˋpiInfoBuilder杩涜瀹氬埗
- return new ApiInfoBuilder()
- // 璁剧疆鏍囬
- .title(title)
- // 鎻忚堪
- .description(description)
- // 浣滆�呬俊鎭�
- .contact(new Contact(ruoyiConfig.getName(), null, null))
- // 鐗堟湰
- .version(version)
- .build();
- }
+ /**
+ * 娣诲姞鎽樿淇℃伅
+ */
+ private ApiInfo apiInfo() {
+ // 鐢ˋpiInfoBuilder杩涜瀹氬埗
+ SwaggerProperties.Contact contact = swaggerProperties.getContact();
+ return new ApiInfoBuilder()
+ // 璁剧疆鏍囬
+ .title(swaggerProperties.getTitle())
+ // 鎻忚堪
+ .description(swaggerProperties.getDescription())
+ // 浣滆�呬俊鎭�
+ .contact(new Contact(contact.getName(), contact.getUrl(), contact.getEmail()))
+ // 鐗堟湰
+ .version(swaggerProperties.getVersion())
+ .build();
+ }
}
diff --git a/ruoyi-framework/src/main/java/com/ruoyi/framework/config/properties/SwaggerProperties.java b/ruoyi-framework/src/main/java/com/ruoyi/framework/config/properties/SwaggerProperties.java
index 4a37fbc..4db6e58 100644
--- a/ruoyi-framework/src/main/java/com/ruoyi/framework/config/properties/SwaggerProperties.java
+++ b/ruoyi-framework/src/main/java/com/ruoyi/framework/config/properties/SwaggerProperties.java
@@ -2,7 +2,6 @@
import lombok.Data;
import lombok.NoArgsConstructor;
-import lombok.experimental.Accessors;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@@ -33,4 +32,28 @@
*/
private String version;
+ /**
+ * 鑱旂郴鏂瑰紡
+ */
+ private Contact contact;
+
+ @Data
+ @NoArgsConstructor
+ public static class Contact{
+
+ /**
+ * 鑱旂郴浜�
+ **/
+ private String name;
+ /**
+ * 鑱旂郴浜簎rl
+ **/
+ private String url;
+ /**
+ * 鑱旂郴浜篹mail
+ **/
+ private String email;
+
+ }
+
}
--
Gitblit v1.9.3