swagger 推广后台 优化对战百佳历史接口
This commit is contained in:
+14
-10
@@ -19,7 +19,7 @@
|
||||
| 缓存 | Redis（Spring Data Redis + Lettuce） |
|
||||
| 消息 | RabbitMQ（业务侧配置虚拟主机等，详见各 profile） |
|
||||
| 实时 | WebSocket（如 `/ws/**` 等路径，与安全放行配置保持一致） |
|
||||
| API 文档 | **Springfox 3.x**（主用，Swagger / OAS3 分组）；另引入 **springdoc-openapi** Starter，可与 Springfox 并行存在 |
|
||||
| API 文档 | 已移除（不再依赖 Springfox / springdoc，仓库内无 Swagger UI 与 OpenAPI 端点） |
|
||||
|
||||
---
|
||||
|
||||
@@ -81,7 +81,7 @@ chengdu-backend/
|
||||
|
||||
### 对外匿名接口（简述）
|
||||
|
||||
与安全配置对齐的常见分类包括：`/login`、`/register`、`/captchaImage`，以及业务侧的 `/api/**`、`/admin/**`、WebSocket、部分 Swagger 与 Druid 监控路径等。具体请以 `ruoyi-framework` 中 **SecurityFilterChain** 与白名单配置为准。
|
||||
与安全配置对齐的常见分类包括：`/login`、`/register`、`/captchaImage`，以及业务侧的 `/api/**`、`/admin/**`、WebSocket、Druid 监控路径等。具体请以 `ruoyi-framework` 中 **SecurityFilterChain** 与白名单配置为准。
|
||||
|
||||
---
|
||||
|
||||
@@ -130,7 +130,7 @@ mvn -pl ruoyi-admin -am spring-boot:run -DskipTests
|
||||
- 技术栈：Vue CLI、Element UI（`package.json` 声明 Node `>=8.9`，实际开发建议 Node **16 LTS** 或 **18 LTS**，并按需开启 OpenSSL 兼容）。
|
||||
- 脚本见 `ruoyi-ui/package.json`（Windows 脚本含 `set NODE_OPTIONS=--openssl-legacy-provider`；在 macOS/Linux 上需 `export NODE_OPTIONS=...` 或使用等价脚本）。
|
||||
- 开发与打包：`npm run dev`、`npm run build:prod` 等。
|
||||
- 系统工具内「Swagger」页当前 iframe 指向 **`/doc.html`**；若后端未部署对应聚合页，请改为与下文 **API 文档** 中实际地址一致（例如 `/swagger-ui.html`）。
|
||||
- 原「系统工具 → 系统接口」的 Swagger 页已随接口文档一并删除（`views/tool/swagger/index.vue`），若侧边栏仍有该菜单，执行 `DELETE FROM sys_menu WHERE component = 'tool/swagger/index';` 后重新登录。
|
||||
|
||||
### promo-ui2（Vue 3）
|
||||
|
||||
@@ -158,16 +158,14 @@ mvn -pl ruoyi-admin -am spring-boot:run -DskipTests
|
||||
|
||||
## API 文档
|
||||
|
||||
- **Springfox（当前主要使用）**：启动后访问（端口与 `server.port` 一致，仓库默认 **28081**）
|
||||
`http://localhost:28081/swagger-ui.html`
|
||||
在页面右上角切换分组（如 `user`、`thirdParty`、`playingMethod`、`task`、`promo` 等；与 `SwaggerConfig` 中 Docket 一致）。OpenAPI JSON 路径形如 `/<group>/api-docs`（Spring Security 已对 `/*/api-docs` 等放行，以实际配置为准）。
|
||||
- **springdoc-openapi**：`ruoyi-admin` 已引入依赖；若单独启用 SpringDoc UI，需确保 **Security** 对 `/swagger-ui/**`、`/v3/api-docs` 等路径放行，避免 401。
|
||||
- 项目已**移除全部接口文档能力**：删除 Springfox（`springfox-boot-starter`）、springdoc-openapi 依赖、`SwaggerConfig` 与源码中的 `@Api` / `@ApiOperation` / `@ApiModelProperty` 等注解，`SecurityConfig` 与 `ResourcesConfig` 里对应的放行与静态映射也已去掉。
|
||||
- 因此 `/swagger-ui.html`、`/v3/api-docs`、`/*/api-docs`、`/doc.html` 均不再对外提供服务（未认证访问会直接落到 401）。
|
||||
|
||||
---
|
||||
|
||||
## 版本信息
|
||||
|
||||
- 父 POM：`com.ruoyi:ruoyi:4.8.2`（`spring-boot.version` **4.0.3**，`springdoc.version` **3.0.2**，`swagger` / Springfox **3.0.0**）
|
||||
- 父 POM：`com.ruoyi:ruoyi:4.8.2`（`spring-boot.version` **4.0.3**）
|
||||
- 若依官网参考：<http://www.ruoyi.vip>
|
||||
|
||||
---
|
||||
@@ -175,7 +173,13 @@ mvn -pl ruoyi-admin -am spring-boot:run -DskipTests
|
||||
## 安全建议
|
||||
|
||||
1. 轮换并私有化所有第三方（支付宝、聚合支付、短信等）密钥；生产环境勿使用仓库内示例明文。
|
||||
2. 修改 JWT `token.secret` 与 Druid 监控口令等非默认值。
|
||||
3. 按需收紧 Druid、`/actuator`（若启用）及 Swagger 相关路径的访问范围。
|
||||
2. 修改 JWT `token.secret` 等非默认值。
|
||||
3. Druid 监控台：生产已关闭（`application-pro.yml` 的 `statViewServlet.enabled=false`，`/druid/**` 是匿名放行的，开着等于把全部 SQL 与连接信息暴露到公网）；
|
||||
开发环境已限制 `allow: 127.0.0.1` 并改用非默认口令。临时排障如需开启，务必保持白名单 + 改口令，用完立即关回。
|
||||
4. **三端 token 互不通用**（游戏管理后台 / 推广后台 / 玩家端）：三个端共用同一套 JWT 与会话存储，
|
||||
靠 `LoginUser.loginScope`（`admin` / `promo` / `player`）区分，判定在 `ruoyi-framework` 的 `SecurityConfig`：
|
||||
`/admin|/system|/monitor|/tool|/test` 只认后台账号、`/promo/**` 只认推广端签发的 token、`/api/**` 只认玩家端签发的 token。
|
||||
标记由 `ApiUserDetailsServiceImpl` 按登录账号前缀（`api_` / `promo_` / `promo_user_` / 无前缀）写入，随会话缓存在 Redis。
|
||||
**注意**：升级到该版本后，不带端标记的旧 token 会被拒绝，推广后台与玩家端需要重新登录一次（后台账号不受影响）。
|
||||
|
||||
如有与本说明不一致之处，以当前仓库代码及团队部署文档为准。
|
||||
|
||||
Reference in New Issue
Block a user