update 优化 默认使用服务名去除前缀当Path 支持自定义Path

config/dev/application-common.yml

@@ -257,6 +257,10 @@ swagger:
         type: APIKEY
         in: HEADER
         name: ${sa-token.token-name}
+  # 服务文档路径映射 参考 gateway router 配置
+  # 默认为服务名去除前缀转换为path 此处填特殊的配置
+  service-mapping:
+    ruoyi-gen: /code
 
 # seata配置
 seata:

ruoyi-common/ruoyi-common-doc/src/main/java/com/ruoyi/common/doc/config/SwaggerAutoConfiguration.java

@@ -23,6 +23,7 @@ import org.springframework.context.annotation.Bean;
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 
 /**
@@ -90,9 +91,22 @@ public class SwaggerAutoConfiguration {
      */
     @Bean
     public OpenApiCustomiser openApiCustomiser() {
+        // 如果服务的自定义 Path 不存在 则采用默认去除前缀当 Path
+        Map<String, String> serviceMapping = swaggerProperties.getServiceMapping();
+        String appPath;
+        if (serviceMapping.containsKey(appName)) {
+            appPath = serviceMapping.get(appName);
+        } else {
+            appPath = "/" + StringUtils.substring(appName, appName.indexOf("-") + 1);
+        }
+
         String contextPath = serverProperties.getServlet().getContextPath();
-        String appPath = "/" + StringUtils.substring(appName, appName.indexOf("-") + 1);
+        String finalContextPath;
-        String finalContextPath = StringUtils.isBlank(contextPath) || "/".equals(contextPath) ? appPath : appPath + contextPath;
+        if (StringUtils.isBlank(contextPath) || "/".equals(contextPath)) {
+            finalContextPath = appPath;
+        } else {
+            finalContextPath = appPath + contextPath;
+        }
         // 对所有路径增加前置上下文路径
         return openApi -> {
             Paths oldPaths = openApi.getPaths();

ruoyi-common/ruoyi-common-doc/src/main/java/com/ruoyi/common/doc/config/properties/SwaggerProperties.java

@@ -11,6 +11,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.NestedConfigurationProperty;
 
 import java.util.List;
+import java.util.Map;
 
 /**
  * swagger 配置属性
@@ -55,6 +56,12 @@ public class SwaggerProperties {
     @NestedConfigurationProperty
     private Components components = null;
 
+    /**
+     * 服务文档路径映射 参考 gateway router 配置
+     * 默认为服务名去除前缀转换为path 此处填特殊的配置
+     */
+    private Map<String, String> serviceMapping = null;
+
     /**
      * <p>
      * 文档的基础属性信息