feat: 添加Swagger UI支持

- pom.xml: 添加springdoc-openapi-starter-webmvc-ui依赖
- application.yml: 添加swagger-ui路径排除配置
- application.yml: 添加H5模块到API分组
- vite.config.js: 添加Swagger代理配置
This commit is contained in:
神码-方晓辉 2026-02-03 09:25:37 +08:00
parent dcadd41e2b
commit dab220d0a2
6 changed files with 58 additions and 8 deletions

View File

@ -81,6 +81,11 @@
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
<version>${springdoc.version}</version>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>${springdoc.version}</version>
</dependency>
<dependency>
<groupId>com.github.therapi</groupId>
<artifactId>therapi-runtime-javadoc</artifactId>

View File

@ -133,6 +133,12 @@
<version>${springdoc.version}</version>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>${springdoc.version}</version>
</dependency>
<dependency>
<groupId>com.github.therapi</groupId>
<artifactId>therapi-runtime-javadoc</artifactId>

View File

@ -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攻击

View File

@ -20,6 +20,10 @@
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
</dependency>
<dependency>
<groupId>com.github.therapi</groupId>
<artifactId>therapi-runtime-javadoc</artifactId>

View File

@ -26,6 +26,12 @@
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
</dependency>
<!-- Swagger UI -->
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
</dependency>
<dependency>
<groupId>com.github.therapi</groupId>
<artifactId>therapi-runtime-javadoc</artifactId>

View File

@ -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
}
}
},