From dab220d0a21c836173ba88e0c6ca8f04424a29bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=A5=9E=E7=A0=81-=E6=96=B9=E6=99=93=E8=BE=89?= Date: Tue, 3 Feb 2026 09:25:37 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E6=B7=BB=E5=8A=A0Swagger=20UI=E6=94=AF?= =?UTF-8?q?=E6=8C=81?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - pom.xml: 添加springdoc-openapi-starter-webmvc-ui依赖 - application.yml: 添加swagger-ui路径排除配置 - application.yml: 添加H5模块到API分组 - vite.config.js: 添加Swagger代理配置 --- backend/.flattened-pom.xml | 5 ++++ backend/pom.xml | 6 +++++ .../src/main/resources/application.yml | 18 +++++++++---- .../ruoyi-common-doc/.flattened-pom.xml | 4 +++ backend/ruoyi-common/ruoyi-common-doc/pom.xml | 6 +++++ frontend/ruoyi-ui/vite.config.js | 27 ++++++++++++++++--- 6 files changed, 58 insertions(+), 8 deletions(-) diff --git a/backend/.flattened-pom.xml b/backend/.flattened-pom.xml index 3fe7a0e..49a5117 100644 --- a/backend/.flattened-pom.xml +++ b/backend/.flattened-pom.xml @@ -81,6 +81,11 @@ springdoc-openapi-starter-webmvc-api ${springdoc.version} + + org.springdoc + springdoc-openapi-starter-webmvc-ui + ${springdoc.version} + com.github.therapi therapi-runtime-javadoc diff --git a/backend/pom.xml b/backend/pom.xml index d18e0a6..1a301bc 100644 --- a/backend/pom.xml +++ b/backend/pom.xml @@ -133,6 +133,12 @@ ${springdoc.version} + + org.springdoc + springdoc-openapi-starter-webmvc-ui + ${springdoc.version} + + com.github.therapi therapi-runtime-javadoc diff --git a/backend/ruoyi-admin/src/main/resources/application.yml b/backend/ruoyi-admin/src/main/resources/application.yml index 49ed080..c81b3ea 100644 --- a/backend/ruoyi-admin/src/main/resources/application.yml +++ b/backend/ruoyi-admin/src/main/resources/application.yml @@ -115,6 +115,12 @@ security: - /error - /*/api-docs - /*/api-docs/** + - /v3/api-docs + - /v3/api-docs/** + - /swagger-ui/** + - /swagger-ui.html + - /swagger-resources/** + - /webjars/** - /warm-flow-ui/config # H5公开接口 - /h5/auth/** @@ -200,15 +206,17 @@ springdoc: url: https://gitee.com/dromara/RuoYi-Vue-Plus #这里定义了两个分组,可定义多个,也可以不定义 group-configs: - - group: 1.演示模块 + - group: 1.H5会员接口 + packages-to-scan: org.dromara.pangu.h5 + - group: 2.演示模块 packages-to-scan: org.dromara.demo - - group: 2.通用模块 + - group: 3.通用模块 packages-to-scan: org.dromara.web - - group: 3.系统模块 + - group: 4.系统模块 packages-to-scan: org.dromara.system - - group: 4.代码生成模块 + - group: 5.代码生成模块 packages-to-scan: org.dromara.generator - - group: 5.工作流模块 + - group: 6.工作流模块 packages-to-scan: org.dromara.workflow # 防止XSS攻击 diff --git a/backend/ruoyi-common/ruoyi-common-doc/.flattened-pom.xml b/backend/ruoyi-common/ruoyi-common-doc/.flattened-pom.xml index cc0be24..4878b50 100644 --- a/backend/ruoyi-common/ruoyi-common-doc/.flattened-pom.xml +++ b/backend/ruoyi-common/ruoyi-common-doc/.flattened-pom.xml @@ -20,6 +20,10 @@ org.springdoc springdoc-openapi-starter-webmvc-api + + org.springdoc + springdoc-openapi-starter-webmvc-ui + com.github.therapi therapi-runtime-javadoc diff --git a/backend/ruoyi-common/ruoyi-common-doc/pom.xml b/backend/ruoyi-common/ruoyi-common-doc/pom.xml index c6199a1..bed64fb 100644 --- a/backend/ruoyi-common/ruoyi-common-doc/pom.xml +++ b/backend/ruoyi-common/ruoyi-common-doc/pom.xml @@ -26,6 +26,12 @@ springdoc-openapi-starter-webmvc-api + + + org.springdoc + springdoc-openapi-starter-webmvc-ui + + com.github.therapi therapi-runtime-javadoc diff --git a/frontend/ruoyi-ui/vite.config.js b/frontend/ruoyi-ui/vite.config.js index d3d9b6d..496b297 100644 --- a/frontend/ruoyi-ui/vite.config.js +++ b/frontend/ruoyi-ui/vite.config.js @@ -52,10 +52,31 @@ export default defineConfig(({ mode, command }) => { changeOrigin: true, rewrite: (p) => p.replace(/^\/dev-api/, '') }, - // springdoc proxy - '^/v3/api-docs/(.*)': { + // Swagger/Knife4j 文档代理 + '/doc.html': { target: baseUrl, - changeOrigin: true, + changeOrigin: true + }, + '/swagger-ui': { + target: baseUrl, + changeOrigin: true + }, + '/swagger-resources': { + target: baseUrl, + changeOrigin: true + }, + '/webjars': { + target: baseUrl, + changeOrigin: true + }, + '/v3/api-docs': { + target: baseUrl, + changeOrigin: true + }, + // H5接口代理(便于测试) + '/h5': { + target: baseUrl, + changeOrigin: true } } },