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:
parent
dcadd41e2b
commit
dab220d0a2
|
|
@ -81,6 +81,11 @@
|
||||||
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
|
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
|
||||||
<version>${springdoc.version}</version>
|
<version>${springdoc.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springdoc</groupId>
|
||||||
|
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
|
||||||
|
<version>${springdoc.version}</version>
|
||||||
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>com.github.therapi</groupId>
|
<groupId>com.github.therapi</groupId>
|
||||||
<artifactId>therapi-runtime-javadoc</artifactId>
|
<artifactId>therapi-runtime-javadoc</artifactId>
|
||||||
|
|
|
||||||
|
|
@ -133,6 +133,12 @@
|
||||||
<version>${springdoc.version}</version>
|
<version>${springdoc.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springdoc</groupId>
|
||||||
|
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
|
||||||
|
<version>${springdoc.version}</version>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>com.github.therapi</groupId>
|
<groupId>com.github.therapi</groupId>
|
||||||
<artifactId>therapi-runtime-javadoc</artifactId>
|
<artifactId>therapi-runtime-javadoc</artifactId>
|
||||||
|
|
|
||||||
|
|
@ -115,6 +115,12 @@ security:
|
||||||
- /error
|
- /error
|
||||||
- /*/api-docs
|
- /*/api-docs
|
||||||
- /*/api-docs/**
|
- /*/api-docs/**
|
||||||
|
- /v3/api-docs
|
||||||
|
- /v3/api-docs/**
|
||||||
|
- /swagger-ui/**
|
||||||
|
- /swagger-ui.html
|
||||||
|
- /swagger-resources/**
|
||||||
|
- /webjars/**
|
||||||
- /warm-flow-ui/config
|
- /warm-flow-ui/config
|
||||||
# H5公开接口
|
# H5公开接口
|
||||||
- /h5/auth/**
|
- /h5/auth/**
|
||||||
|
|
@ -200,15 +206,17 @@ springdoc:
|
||||||
url: https://gitee.com/dromara/RuoYi-Vue-Plus
|
url: https://gitee.com/dromara/RuoYi-Vue-Plus
|
||||||
#这里定义了两个分组,可定义多个,也可以不定义
|
#这里定义了两个分组,可定义多个,也可以不定义
|
||||||
group-configs:
|
group-configs:
|
||||||
- group: 1.演示模块
|
- group: 1.H5会员接口
|
||||||
|
packages-to-scan: org.dromara.pangu.h5
|
||||||
|
- group: 2.演示模块
|
||||||
packages-to-scan: org.dromara.demo
|
packages-to-scan: org.dromara.demo
|
||||||
- group: 2.通用模块
|
- group: 3.通用模块
|
||||||
packages-to-scan: org.dromara.web
|
packages-to-scan: org.dromara.web
|
||||||
- group: 3.系统模块
|
- group: 4.系统模块
|
||||||
packages-to-scan: org.dromara.system
|
packages-to-scan: org.dromara.system
|
||||||
- group: 4.代码生成模块
|
- group: 5.代码生成模块
|
||||||
packages-to-scan: org.dromara.generator
|
packages-to-scan: org.dromara.generator
|
||||||
- group: 5.工作流模块
|
- group: 6.工作流模块
|
||||||
packages-to-scan: org.dromara.workflow
|
packages-to-scan: org.dromara.workflow
|
||||||
|
|
||||||
# 防止XSS攻击
|
# 防止XSS攻击
|
||||||
|
|
|
||||||
|
|
@ -20,6 +20,10 @@
|
||||||
<groupId>org.springdoc</groupId>
|
<groupId>org.springdoc</groupId>
|
||||||
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
|
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springdoc</groupId>
|
||||||
|
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
|
||||||
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>com.github.therapi</groupId>
|
<groupId>com.github.therapi</groupId>
|
||||||
<artifactId>therapi-runtime-javadoc</artifactId>
|
<artifactId>therapi-runtime-javadoc</artifactId>
|
||||||
|
|
|
||||||
|
|
@ -26,6 +26,12 @@
|
||||||
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
|
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
|
||||||
|
<!-- Swagger UI -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springdoc</groupId>
|
||||||
|
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>com.github.therapi</groupId>
|
<groupId>com.github.therapi</groupId>
|
||||||
<artifactId>therapi-runtime-javadoc</artifactId>
|
<artifactId>therapi-runtime-javadoc</artifactId>
|
||||||
|
|
|
||||||
|
|
@ -52,10 +52,31 @@ export default defineConfig(({ mode, command }) => {
|
||||||
changeOrigin: true,
|
changeOrigin: true,
|
||||||
rewrite: (p) => p.replace(/^\/dev-api/, '')
|
rewrite: (p) => p.replace(/^\/dev-api/, '')
|
||||||
},
|
},
|
||||||
// springdoc proxy
|
// Swagger/Knife4j 文档代理
|
||||||
'^/v3/api-docs/(.*)': {
|
'/doc.html': {
|
||||||
target: baseUrl,
|
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
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue