befly-tpl 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.env.development +83 -0
- package/LICENSE +201 -0
- package/README.md +20 -0
- package/README.ts.md +175 -0
- package/addon-loader.example.ts +99 -0
- package/addons/_template/README.md +123 -0
- package/addons/_template/addon.config.json +17 -0
- package/addons/_template/apis/example.ts +33 -0
- package/addons/_template/checks/example.ts +23 -0
- package/addons/_template/config/default.ts +12 -0
- package/addons/_template/plugins/example.ts +39 -0
- package/addons/_template/tables/example.json +7 -0
- package/addons/_template/types/index.d.ts +21 -0
- package/addons/admin/README.md +179 -0
- package/addons/admin/addon.config.json +13 -0
- package/addons/admin/apis/adminDel.ts +37 -0
- package/addons/admin/apis/adminInfo.ts +50 -0
- package/addons/admin/apis/adminIns.ts +70 -0
- package/addons/admin/apis/adminList.ts +24 -0
- package/addons/admin/apis/adminRoleDetail.ts +38 -0
- package/addons/admin/apis/adminRoleSave.ts +40 -0
- package/addons/admin/apis/adminUpd.ts +54 -0
- package/addons/admin/apis/apiAll.ts +38 -0
- package/addons/admin/apis/cacheRefresh.ts +36 -0
- package/addons/admin/apis/dashboardAddonList.ts +16 -0
- package/addons/admin/apis/dashboardChangelog.ts +41 -0
- package/addons/admin/apis/dashboardConfigStatus.ts +56 -0
- package/addons/admin/apis/dashboardEnvironmentInfo.ts +48 -0
- package/addons/admin/apis/dashboardPerformanceMetrics.ts +25 -0
- package/addons/admin/apis/dashboardPermissionStats.ts +33 -0
- package/addons/admin/apis/dashboardServiceStatus.ts +84 -0
- package/addons/admin/apis/dashboardSystemInfo.ts +34 -0
- package/addons/admin/apis/dashboardSystemOverview.ts +34 -0
- package/addons/admin/apis/dashboardSystemResources.ts +119 -0
- package/addons/admin/apis/dictAll.ts +26 -0
- package/addons/admin/apis/dictDel.ts +27 -0
- package/addons/admin/apis/dictDetail.ts +28 -0
- package/addons/admin/apis/dictIns.ts +38 -0
- package/addons/admin/apis/dictList.ts +27 -0
- package/addons/admin/apis/dictUpd.ts +44 -0
- package/addons/admin/apis/login.ts +123 -0
- package/addons/admin/apis/logout.ts +23 -0
- package/addons/admin/apis/menuAll.ts +70 -0
- package/addons/admin/apis/menuDel.ts +40 -0
- package/addons/admin/apis/menuIns.ts +31 -0
- package/addons/admin/apis/menuList.ts +26 -0
- package/addons/admin/apis/menuUpd.ts +41 -0
- package/addons/admin/apis/register.ts +50 -0
- package/addons/admin/apis/roleApiDetail.ts +34 -0
- package/addons/admin/apis/roleApiSave.ts +44 -0
- package/addons/admin/apis/roleDel.ts +48 -0
- package/addons/admin/apis/roleDetail.ts +28 -0
- package/addons/admin/apis/roleIns.ts +40 -0
- package/addons/admin/apis/roleList.ts +18 -0
- package/addons/admin/apis/roleMenuDetail.ts +33 -0
- package/addons/admin/apis/roleMenuSave.ts +39 -0
- package/addons/admin/apis/roleSave.ts +45 -0
- package/addons/admin/apis/roleUpd.ts +53 -0
- package/addons/admin/apis/sendSmsCode.ts +36 -0
- package/addons/admin/checks/admin.ts +36 -0
- package/addons/admin/config/index.ts +45 -0
- package/addons/admin/config/menu.json +44 -0
- package/addons/admin/scripts/syncApi.ts +285 -0
- package/addons/admin/scripts/syncDev.ts +203 -0
- package/addons/admin/scripts/syncMenu.ts +210 -0
- package/addons/admin/tables/admin.json +14 -0
- package/addons/admin/tables/api.json +8 -0
- package/addons/admin/tables/dict.json +8 -0
- package/addons/admin/tables/menu.json +8 -0
- package/addons/admin/tables/role.json +8 -0
- package/addons/admin/types/index.ts +44 -0
- package/addons/admin/util.ts +266 -0
- package/addons/befly/addon.config.json +13 -0
- package/addons/befly/apis/health/info.ts +77 -0
- package/addons/befly/apis/tool/tokenCheck.ts +52 -0
- package/addons/demo/README.md +62 -0
- package/addons/demo/addon.config.json +13 -0
- package/addons/demo/apis/demoIns.ts +36 -0
- package/addons/demo/apis/demoList.ts +36 -0
- package/addons/demo/checks/demo.ts +30 -0
- package/addons/demo/config/default.ts +17 -0
- package/addons/demo/plugins/tool.ts +61 -0
- package/addons/demo/tables/todo.json +6 -0
- package/addons/demo/types/index.d.ts +56 -0
- package/apis/article/articleDel.ts +33 -0
- package/apis/article/articleDetail.ts +26 -0
- package/apis/article/articleIns.ts +47 -0
- package/apis/article/articleList.ts +47 -0
- package/apis/article/articleUpd.ts +55 -0
- package/apis/article/increment.ts +37 -0
- package/apis/test/hi.ts +9 -0
- package/apis/user/login.ts +56 -0
- package/apis/user/userList.ts +40 -0
- package/bun.lock +140 -0
- package/checks/demo.ts +25 -0
- package/logs/2025-08-22.0.log +197 -0
- package/logs/2025-08-23.0.log +151 -0
- package/logs/2025-08-24.0.log +296 -0
- package/logs/2025-08-25.0.log +162 -0
- package/logs/2025-08-26.0.log +19 -0
- package/logs/2025-08-27.0.log +63 -0
- package/logs/2025-08-28.0.log +286 -0
- package/logs/2025-08-30.0.log +1 -0
- package/logs/2025-09-01.0.log +296 -0
- package/logs/2025-09-02.0.log +298 -0
- package/logs/2025-10-11.0.log +2718 -0
- package/logs/2025-10-12.0.log +4374 -0
- package/logs/2025-10-13.0.log +759 -0
- package/logs/2025-10-14.0.log +2350 -0
- package/logs/2025-10-15.0.log +2386 -0
- package/logs/2025-10-16.0.log +2807 -0
- package/logs/2025-10-17.0.log +1143 -0
- package/logs/2025-10-18.0.log +1292 -0
- package/logs/2025-10-19.0.log +1752 -0
- package/logs/2025-10-20.0.log +722 -0
- package/logs/2025-10-21.0.log +1075 -0
- package/logs/2025-10-23.0.log +3291 -0
- package/logs/2025-10-24.0.log +2341 -0
- package/logs/2025-10-25.0.log +1367 -0
- package/logs/debug.0.log +25174 -0
- package/main.ts +9 -0
- package/package.json +29 -0
- package/pm2.config.cjs +85 -0
- package/tables/article.json +11 -0
- package/tables/user.json +8 -0
- package/temp/addon-route-prefix-migration.md +400 -0
- package/temp/api-route-conflict-analysis.md +441 -0
- package/temp/interactive-cli-guide.md +199 -0
- package/temp/missing-apis-fix.md +362 -0
- package/temp/remove-status-field.md +239 -0
- package/temp/roleid-to-rolecode-optimization.md +321 -0
- package/temp/status-to-state-migration-complete.md +176 -0
- package/temp/syncMenu-guide.md +235 -0
- package/temp/test-admin-menus-cache.ts +125 -0
- package/temp/test-admin-menus.ts +110 -0
- package/temp/test-interactive-cli.ps1 +14 -0
- package/tests/core.test.ts +13 -0
- package/tsconfig.json +23 -0
- package/types/api.ts +128 -0
- package/types/index.ts +6 -0
- package/types/models.example.ts +267 -0
- package/types/models.ts +67 -0
package/main.ts
ADDED
package/package.json
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "befly-tpl",
|
|
3
|
+
"version": "3.0.1",
|
|
4
|
+
"main": "main.ts",
|
|
5
|
+
"types": "main.ts",
|
|
6
|
+
"description": "Befly 3.0 TypeScript Template",
|
|
7
|
+
"private": false,
|
|
8
|
+
"publishConfig": {
|
|
9
|
+
"access": "public",
|
|
10
|
+
"registry": "https://registry.npmjs.org"
|
|
11
|
+
},
|
|
12
|
+
"scripts": {
|
|
13
|
+
"dev": "bun run main.ts",
|
|
14
|
+
"serve": "bunx --bun pm2 start pm2.config.cjs -a",
|
|
15
|
+
"test": "bun test",
|
|
16
|
+
"test:api": "bun run test-api-runner.ts",
|
|
17
|
+
"syncDb": "befly syncDb",
|
|
18
|
+
"syncDev": " befly syncDev"
|
|
19
|
+
},
|
|
20
|
+
"type": "module",
|
|
21
|
+
"dependencies": {
|
|
22
|
+
"befly": "3.0.1",
|
|
23
|
+
"befly-cli": "3.0.1"
|
|
24
|
+
},
|
|
25
|
+
"engines": {
|
|
26
|
+
"bun": ">=1.3.0"
|
|
27
|
+
},
|
|
28
|
+
"gitHead": "f96bac1a1c829e265284a6f619da680fffd1a075"
|
|
29
|
+
}
|
package/pm2.config.cjs
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
module.exports = {
|
|
2
|
+
apps: [
|
|
3
|
+
{
|
|
4
|
+
name: 'yiapi',
|
|
5
|
+
instances: 4,
|
|
6
|
+
script: './main.js',
|
|
7
|
+
exec_mode: 'cluster',
|
|
8
|
+
watch: false,
|
|
9
|
+
autorestart: true,
|
|
10
|
+
interpreter: 'bun',
|
|
11
|
+
ignore_watch: ['node_modules', 'logs', 'data'],
|
|
12
|
+
max_memory_restart: '200M',
|
|
13
|
+
env: {
|
|
14
|
+
NODE_ENV: 'production',
|
|
15
|
+
// 项目名称
|
|
16
|
+
APP_NAME: '易接口',
|
|
17
|
+
APP_PORT: 3000,
|
|
18
|
+
// MD5加密盐
|
|
19
|
+
MD5_SALT: 'a2ccfeba-818a-51c8-b1a4-939bade73088',
|
|
20
|
+
// 监听端口,
|
|
21
|
+
APP_HOST: '127.0.0.1',
|
|
22
|
+
// 开发管理员密码,
|
|
23
|
+
DEV_PASSWORD: '123456',
|
|
24
|
+
// 请求体大小,
|
|
25
|
+
BODY_LIMIT: 10,
|
|
26
|
+
// 参数检查,
|
|
27
|
+
PARAMS_CHECK: 0,
|
|
28
|
+
// 日志等级,
|
|
29
|
+
LOG_EXCLUDE_FIELDS: 'password,token',
|
|
30
|
+
LOG_LEVEL: 'info',
|
|
31
|
+
LOG_DIR: './logs',
|
|
32
|
+
LOG_TO_CONSOLE: 1,
|
|
33
|
+
LOG_MAX_SIZE: 52428800, // 50MB,
|
|
34
|
+
// 时区,
|
|
35
|
+
TZ: 'Asia/Shanghai',
|
|
36
|
+
// 跨域配置
|
|
37
|
+
ALLOWED_METHODS: 'GET, POST, PUT, DELETE, OPTIONS',
|
|
38
|
+
ALLOWED_HEADERS: 'Content-Type, Authorization, authorization, token',
|
|
39
|
+
EXPOSE_HEADERS: 'Content-Range, X-Content-Range, Authorization, authorization, token',
|
|
40
|
+
MAX_AGE: 86400,
|
|
41
|
+
ALLOW_CREDENTIALS: 'true',
|
|
42
|
+
// 数据库配置(DB_* 通用参数),
|
|
43
|
+
DB_ENABLE: 1,
|
|
44
|
+
DB_TYPE: 'mysql',
|
|
45
|
+
DB_HOST: '127.0.0.1',
|
|
46
|
+
DB_PORT: 3306,
|
|
47
|
+
DB_USER: 'root',
|
|
48
|
+
DB_PASS: 'root',
|
|
49
|
+
DB_NAME: 'test',
|
|
50
|
+
DB_POOL_MAX: 10,
|
|
51
|
+
DB_DEBUG: 0,
|
|
52
|
+
// redis 配置,
|
|
53
|
+
REDIS_ENABLE: 1,
|
|
54
|
+
REDIS_URL: 'redis://root:root@127.0.0.1:6379',
|
|
55
|
+
REDIS_HOST: '127.0.0.1',
|
|
56
|
+
REDIS_PORT: 6379,
|
|
57
|
+
REDIS_USERNAME: '',
|
|
58
|
+
REDIS_PASSWORD: '',
|
|
59
|
+
REDIS_DB: 3,
|
|
60
|
+
REDIS_KEY_PREFIX: '',
|
|
61
|
+
// JWT 配置,
|
|
62
|
+
JWT_SECRET: 'dbfaf2c3-7ade-5042-b843-eca8814714b3',
|
|
63
|
+
JWT_EXPIRES_IN: '30d',
|
|
64
|
+
JWT_ALGORITHM: 'HS256',
|
|
65
|
+
// 邮箱配置,
|
|
66
|
+
MAIL_HOST: 'smtp.qq.com',
|
|
67
|
+
MAIL_PORT: 465,
|
|
68
|
+
MAIL_POOL: 1,
|
|
69
|
+
MAIL_SECURE: 1,
|
|
70
|
+
MAIL_USER: '',
|
|
71
|
+
MAIL_PASS: '',
|
|
72
|
+
MAIL_SENDER: '',
|
|
73
|
+
MAIL_ADDRESS: 'demo@qq.com',
|
|
74
|
+
// 上传配置,
|
|
75
|
+
LOCAL_DIR: '/wwwroot/static2/',
|
|
76
|
+
// 微信配置,
|
|
77
|
+
PAY_NOTIFY_URL: '',
|
|
78
|
+
// --- 同步脚本开关(用于表结构同步) ---
|
|
79
|
+
SYNC_MERGE_ALTER: 1,
|
|
80
|
+
SYNC_DISALLOW_SHRINK: 1,
|
|
81
|
+
SYNC_ALLOW_TYPE_CHANGE: 0
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
]
|
|
85
|
+
};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
{
|
|
2
|
+
"title": "标题|string|1|200|null|1|null",
|
|
3
|
+
"content": "内容|text|null|null|null|0|null",
|
|
4
|
+
"summary": "摘要|string|0|500|null|0|null",
|
|
5
|
+
"coverImage": "封面图|string|0|500|null|0|null",
|
|
6
|
+
"author": "作者|string|1|50|佚名|0|null",
|
|
7
|
+
"category": "分类|string|1|50|默认|1|null",
|
|
8
|
+
"tags": "标签|array_string|0|10|null|0|null",
|
|
9
|
+
"viewCount": "浏览量|number|0|999999999|0|0|null",
|
|
10
|
+
"status": "状态|string|1|20|draft|1|^(draft|published|archived)$"
|
|
11
|
+
}
|
package/tables/user.json
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
{
|
|
2
|
+
"username": "用户名|string|3|50|null|1|^[a-zA-Z0-9_]+$",
|
|
3
|
+
"password": "密码|string|6|255|null|0|null",
|
|
4
|
+
"email": "邮箱|string|5|100|null|1|^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
|
|
5
|
+
"role": "角色|string|1|20|user|1|^(admin|user|guest)$",
|
|
6
|
+
"nickname": "昵称|string|0|50|null|0|null",
|
|
7
|
+
"avatar": "头像|string|0|500|null|0|null"
|
|
8
|
+
}
|
|
@@ -0,0 +1,400 @@
|
|
|
1
|
+
# Addon 路由前缀迁移报告(方案2)
|
|
2
|
+
|
|
3
|
+
**日期**:2025-10-19
|
|
4
|
+
**执行人**:AI Assistant
|
|
5
|
+
**状态**:✅ 已完成
|
|
6
|
+
|
|
7
|
+
## 📋 迁移概述
|
|
8
|
+
|
|
9
|
+
根据用户要求,执行方案2:修改 Addon 路由前缀,从 `/api/{addonName}/` 改为 `/api/addon/{addonName}/`,彻底解决路由冲突问题。
|
|
10
|
+
|
|
11
|
+
## 🎯 修改目标
|
|
12
|
+
|
|
13
|
+
**修改前**:
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
Addon API: POST/api/admin/login
|
|
17
|
+
项目 API: POST/api/admin/login
|
|
18
|
+
⚠️ 可能冲突
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
**修改后**:
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
Addon API: POST/api/addon/admin/login
|
|
25
|
+
项目 API: POST/api/admin/login
|
|
26
|
+
✅ 完全隔离,不会冲突
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## ✅ 完成的修改
|
|
30
|
+
|
|
31
|
+
### 1. 核心框架修改
|
|
32
|
+
|
|
33
|
+
#### packages/core/lifecycle/loader.ts
|
|
34
|
+
|
|
35
|
+
**文件**:`packages/core/lifecycle/loader.ts`
|
|
36
|
+
**位置**:Line 493-495
|
|
37
|
+
**修改内容**:添加 `addon/` 前缀到 addon API 路由
|
|
38
|
+
|
|
39
|
+
**修改前**:
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
// 构建路由:addon 接口添加前缀 /api/{addonName}/{apiPath}
|
|
43
|
+
if (isAddon) {
|
|
44
|
+
api.route = `${api.method.toUpperCase()}/api/${addonName}/${apiPath}`;
|
|
45
|
+
} else {
|
|
46
|
+
api.route = `${api.method.toUpperCase()}/api/${apiPath}`;
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
**修改后**:
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
// 构建路由:addon 接口添加前缀 /api/addon/{addonName}/{apiPath},项目接口为 /api/{apiPath}
|
|
54
|
+
if (isAddon) {
|
|
55
|
+
api.route = `${api.method.toUpperCase()}/api/addon/${addonName}/${apiPath}`;
|
|
56
|
+
} else {
|
|
57
|
+
api.route = `${api.method.toUpperCase()}/api/${apiPath}`;
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### 2. Admin 前端项目修改
|
|
62
|
+
|
|
63
|
+
#### 修改的文件列表(共7个文件)
|
|
64
|
+
|
|
65
|
+
1. **packages/admin/src/plugins/http.ts**
|
|
66
|
+
- 更新注释示例:`/api/admin/login` → `/addon/admin/login`
|
|
67
|
+
|
|
68
|
+
2. **packages/admin/src/plugins/router.ts**
|
|
69
|
+
- 无需修改(没有硬编码路径)
|
|
70
|
+
|
|
71
|
+
3. **packages/admin/src/stores/permission.ts**
|
|
72
|
+
- `/admin/adminMenus` → `/addon/admin/adminMenus`
|
|
73
|
+
|
|
74
|
+
4. **packages/admin/src/api/auth.ts**
|
|
75
|
+
- `/admin/login` → `/addon/admin/login`
|
|
76
|
+
- `/admin/register` → `/addon/admin/register`
|
|
77
|
+
- `/admin/sendSmsCode` → `/addon/admin/sendSmsCode`
|
|
78
|
+
- `/admin/adminInfo` → `/addon/admin/adminInfo`
|
|
79
|
+
- `/admin/logout` → `/addon/admin/logout`
|
|
80
|
+
|
|
81
|
+
5. **packages/admin/src/views/login/index_1.vue**
|
|
82
|
+
- `/admin/sendSmsCode` → `/addon/admin/sendSmsCode`
|
|
83
|
+
- `/admin/login` → `/addon/admin/login`
|
|
84
|
+
- `/admin/register` → `/addon/admin/register`
|
|
85
|
+
|
|
86
|
+
6. **packages/admin/src/views/system/menu.vue**
|
|
87
|
+
- `/admin/menuList` → `/addon/admin/menuList`
|
|
88
|
+
- `/admin/menuCreate` → `/addon/admin/menuCreate`
|
|
89
|
+
- `/admin/menuUpdate` → `/addon/admin/menuUpdate`
|
|
90
|
+
- `/admin/menuDelete` → `/addon/admin/menuDelete`
|
|
91
|
+
|
|
92
|
+
7. **packages/admin/src/views/system/role.vue**
|
|
93
|
+
- `/admin/roleList` → `/addon/admin/roleList`
|
|
94
|
+
- `/admin/menuList` → `/addon/admin/menuList`
|
|
95
|
+
- `/admin/roleCreate` → `/addon/admin/roleCreate`
|
|
96
|
+
- `/admin/roleUpdate` → `/addon/admin/roleUpdate`
|
|
97
|
+
- `/admin/roleDelete` → `/addon/admin/roleDelete`
|
|
98
|
+
- `/admin/roleMenuGet` → `/addon/admin/roleMenuGet`
|
|
99
|
+
- `/admin/roleMenuSave` → `/addon/admin/roleMenuSave`
|
|
100
|
+
|
|
101
|
+
8. **packages/admin/src/views/user/user.vue**
|
|
102
|
+
- `/admin/list` → `/addon/admin/list`
|
|
103
|
+
- `/admin/roleList` → `/addon/admin/roleList`
|
|
104
|
+
- `/admin/adminRoleGet` → `/addon/admin/adminRoleGet`
|
|
105
|
+
- `/admin/adminRoleSave` → `/addon/admin/adminRoleSave`
|
|
106
|
+
|
|
107
|
+
9. **packages/admin/src/views/admin/index.vue**
|
|
108
|
+
- `/admin/list` → `/addon/admin/list`
|
|
109
|
+
- `/admin/roleList` → `/addon/admin/roleList`
|
|
110
|
+
- `/admin/adminRoleGet` → `/addon/admin/adminRoleGet`
|
|
111
|
+
- `/admin/adminRoleSave` → `/addon/admin/adminRoleSave`
|
|
112
|
+
|
|
113
|
+
## 📊 修改统计
|
|
114
|
+
|
|
115
|
+
### 核心框架
|
|
116
|
+
|
|
117
|
+
- **修改文件**:1 个
|
|
118
|
+
- **修改行数**:1 行
|
|
119
|
+
- **影响范围**:所有 addon 的 API 路由
|
|
120
|
+
|
|
121
|
+
### Admin 前端
|
|
122
|
+
|
|
123
|
+
- **修改文件**:9 个
|
|
124
|
+
- **修改 API 调用**:32 处
|
|
125
|
+
- **影响范围**:所有调用 admin addon 接口的地方
|
|
126
|
+
|
|
127
|
+
### 总计
|
|
128
|
+
|
|
129
|
+
- **修改文件总数**:10 个
|
|
130
|
+
- **修改代码行数**:约 35 处
|
|
131
|
+
|
|
132
|
+
## 🔍 验证结果
|
|
133
|
+
|
|
134
|
+
**验证命令**:
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
grep -rE "['\"]/admin/" packages/admin/src/**/*.{ts,vue}
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
**结果**:
|
|
141
|
+
|
|
142
|
+
```
|
|
143
|
+
No matches found ✅
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
所有 `/admin/` 路径已成功替换为 `/addon/admin/`!
|
|
147
|
+
|
|
148
|
+
## 🎯 路由映射对照表
|
|
149
|
+
|
|
150
|
+
### Admin Addon 的 API 路由变化
|
|
151
|
+
|
|
152
|
+
| API 文件 | 修改前 | 修改后 |
|
|
153
|
+
| -------------- | ---------------------------- | ---------------------------------- |
|
|
154
|
+
| login.ts | `POST/api/admin/login` | `POST/api/addon/admin/login` |
|
|
155
|
+
| register.ts | `POST/api/admin/register` | `POST/api/addon/admin/register` |
|
|
156
|
+
| adminInfo.ts | `POST/api/admin/adminInfo` | `POST/api/addon/admin/adminInfo` |
|
|
157
|
+
| adminMenus.ts | `POST/api/admin/adminMenus` | `POST/api/addon/admin/adminMenus` |
|
|
158
|
+
| menuList.ts | `POST/api/admin/menuList` | `POST/api/addon/admin/menuList` |
|
|
159
|
+
| menuCreate.ts | `POST/api/admin/menuCreate` | `POST/api/addon/admin/menuCreate` |
|
|
160
|
+
| menuUpdate.ts | `POST/api/admin/menuUpdate` | `POST/api/addon/admin/menuUpdate` |
|
|
161
|
+
| menuDelete.ts | `POST/api/admin/menuDelete` | `POST/api/addon/admin/menuDelete` |
|
|
162
|
+
| roleList.ts | `POST/api/admin/roleList` | `POST/api/addon/admin/roleList` |
|
|
163
|
+
| roleCreate.ts | `POST/api/admin/roleCreate` | `POST/api/addon/admin/roleCreate` |
|
|
164
|
+
| roleUpdate.ts | `POST/api/admin/roleUpdate` | `POST/api/addon/admin/roleUpdate` |
|
|
165
|
+
| roleDelete.ts | `POST/api/admin/roleDelete` | `POST/api/addon/admin/roleDelete` |
|
|
166
|
+
| roleSave.ts | `POST/api/admin/roleSave` | `POST/api/addon/admin/roleSave` |
|
|
167
|
+
| roleGet.ts | `POST/api/admin/roleGet` | `POST/api/addon/admin/roleGet` |
|
|
168
|
+
| sendSmsCode.ts | `POST/api/admin/sendSmsCode` | `POST/api/addon/admin/sendSmsCode` |
|
|
169
|
+
| logout.ts | `POST/api/admin/logout` | `POST/api/addon/admin/logout` |
|
|
170
|
+
|
|
171
|
+
### 其他 Addon 的路由规则
|
|
172
|
+
|
|
173
|
+
所有 addon 都会应用新的路由规则:
|
|
174
|
+
|
|
175
|
+
**Befly Addon**:
|
|
176
|
+
|
|
177
|
+
```
|
|
178
|
+
修改前: POST/api/befly/health/info
|
|
179
|
+
修改后: POST/api/addon/befly/health/info
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
**Demo Addon**:
|
|
183
|
+
|
|
184
|
+
```
|
|
185
|
+
修改前: POST/api/demo/test
|
|
186
|
+
修改后: POST/api/addon/demo/test
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### 项目 API 路由(不受影响)
|
|
190
|
+
|
|
191
|
+
项目 API 保持不变:
|
|
192
|
+
|
|
193
|
+
```
|
|
194
|
+
POST/api/article/list
|
|
195
|
+
POST/api/article/create
|
|
196
|
+
POST/api/user/list
|
|
197
|
+
POST/api/user/login
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
## 💡 迁移优势
|
|
201
|
+
|
|
202
|
+
### 1. 彻底解决冲突
|
|
203
|
+
|
|
204
|
+
**场景:开发者创建 apis/admin/ 目录**
|
|
205
|
+
|
|
206
|
+
**修改前**:
|
|
207
|
+
|
|
208
|
+
```
|
|
209
|
+
⚠️ Addon: POST/api/admin/list
|
|
210
|
+
⚠️ 项目: POST/api/admin/list
|
|
211
|
+
❌ 冲突!后者覆盖前者
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
**修改后**:
|
|
215
|
+
|
|
216
|
+
```
|
|
217
|
+
✅ Addon: POST/api/addon/admin/list
|
|
218
|
+
✅ 项目: POST/api/admin/list
|
|
219
|
+
✅ 完全隔离,不会冲突
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### 2. 路径更清晰
|
|
223
|
+
|
|
224
|
+
**一眼就能区分 API 来源**:
|
|
225
|
+
|
|
226
|
+
```
|
|
227
|
+
/api/addon/admin/login ← 明显是 addon 提供的接口
|
|
228
|
+
/api/admin/login ← 项目自己的接口
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
### 3. 符合命名空间最佳实践
|
|
232
|
+
|
|
233
|
+
```
|
|
234
|
+
/api/addon/{addonName}/{path} ← Addon 命名空间
|
|
235
|
+
/api/{path} ← 项目命名空间
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
### 4. 扩展性更好
|
|
239
|
+
|
|
240
|
+
未来添加更多 addon 不会产生冲突:
|
|
241
|
+
|
|
242
|
+
```
|
|
243
|
+
/api/addon/admin/...
|
|
244
|
+
/api/addon/shop/...
|
|
245
|
+
/api/addon/blog/...
|
|
246
|
+
/api/addon/payment/...
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
## 🚨 注意事项
|
|
250
|
+
|
|
251
|
+
### 1. 兼容性
|
|
252
|
+
|
|
253
|
+
⚠️ **这是破坏性变更**:
|
|
254
|
+
|
|
255
|
+
- 旧版本的前端调用会 404
|
|
256
|
+
- 需要同步更新前端代码
|
|
257
|
+
|
|
258
|
+
### 2. 部署建议
|
|
259
|
+
|
|
260
|
+
**建议部署流程**:
|
|
261
|
+
|
|
262
|
+
1. 先部署后端(core + tpl)
|
|
263
|
+
2. 立即部署前端(admin)
|
|
264
|
+
3. 避免前后端版本不一致
|
|
265
|
+
|
|
266
|
+
### 3. 回滚方案
|
|
267
|
+
|
|
268
|
+
如果需要回滚:
|
|
269
|
+
|
|
270
|
+
```typescript
|
|
271
|
+
// 在 loader.ts 中改回
|
|
272
|
+
if (isAddon) {
|
|
273
|
+
api.route = `${api.method.toUpperCase()}/api/${addonName}/${apiPath}`;
|
|
274
|
+
}
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
## 📋 测试建议
|
|
278
|
+
|
|
279
|
+
### 1. 后端测试
|
|
280
|
+
|
|
281
|
+
```bash
|
|
282
|
+
# 启动后端
|
|
283
|
+
cd packages/tpl
|
|
284
|
+
bunx befly
|
|
285
|
+
|
|
286
|
+
# 验证路由
|
|
287
|
+
curl http://localhost:3000/api/addon/admin/health
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
### 2. 前端测试
|
|
291
|
+
|
|
292
|
+
```bash
|
|
293
|
+
# 启动前端
|
|
294
|
+
cd packages/admin
|
|
295
|
+
bun run dev
|
|
296
|
+
|
|
297
|
+
# 测试功能
|
|
298
|
+
- 登录
|
|
299
|
+
- 获取菜单
|
|
300
|
+
- 菜单管理
|
|
301
|
+
- 角色管理
|
|
302
|
+
- 用户管理
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
### 3. 关键测试点
|
|
306
|
+
|
|
307
|
+
- ✅ 登录功能
|
|
308
|
+
- ✅ 获取用户菜单
|
|
309
|
+
- ✅ 菜单 CRUD
|
|
310
|
+
- ✅ 角色 CRUD
|
|
311
|
+
- ✅ 用户角色分配
|
|
312
|
+
|
|
313
|
+
## 🎓 技术说明
|
|
314
|
+
|
|
315
|
+
### 路由生成逻辑
|
|
316
|
+
|
|
317
|
+
**Addon API**:
|
|
318
|
+
|
|
319
|
+
```typescript
|
|
320
|
+
// 文件:addons/admin/apis/login.ts
|
|
321
|
+
// 路径:POST/api/addon/admin/login
|
|
322
|
+
|
|
323
|
+
const apiPath = 'login'; // 相对于 apis 目录
|
|
324
|
+
const addonName = 'admin';
|
|
325
|
+
const route = `POST/api/addon/${addonName}/${apiPath}`;
|
|
326
|
+
```
|
|
327
|
+
|
|
328
|
+
**项目 API**:
|
|
329
|
+
|
|
330
|
+
```typescript
|
|
331
|
+
// 文件:apis/user/login.ts
|
|
332
|
+
// 路径:POST/api/user/login
|
|
333
|
+
|
|
334
|
+
const apiPath = 'user/login'; // 相对于 apis 目录
|
|
335
|
+
const route = `POST/api/${apiPath}`;
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
### 前端请求示例
|
|
339
|
+
|
|
340
|
+
```typescript
|
|
341
|
+
// Admin 前端(baseURL = http://localhost:3000/api)
|
|
342
|
+
await $Http('/addon/admin/login', { email, password });
|
|
343
|
+
// 实际请求:POST http://localhost:3000/api/addon/admin/login
|
|
344
|
+
|
|
345
|
+
await $Http('/addon/admin/menuList', {});
|
|
346
|
+
// 实际请求:POST http://localhost:3000/api/addon/admin/menuList
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
## 📚 相关文档
|
|
350
|
+
|
|
351
|
+
- 路由冲突分析:`packages/tpl/temp/api-route-conflict-analysis.md`
|
|
352
|
+
- RoleCode 优化:`packages/tpl/temp/roleid-to-rolecode-optimization.md`
|
|
353
|
+
- Status 迁移:`packages/tpl/temp/status-to-state-migration-complete.md`
|
|
354
|
+
|
|
355
|
+
## ✅ 下一步建议
|
|
356
|
+
|
|
357
|
+
1. **更新 AGENTS.md**:
|
|
358
|
+
- 添加新的路由规范说明
|
|
359
|
+
- 更新 API 示例代码
|
|
360
|
+
|
|
361
|
+
2. **更新文档项目**(docs):
|
|
362
|
+
- 说明 addon 路由规则
|
|
363
|
+
- 提供迁移指南
|
|
364
|
+
|
|
365
|
+
3. **测试验证**:
|
|
366
|
+
- 完整测试所有功能
|
|
367
|
+
- 确保前后端正常工作
|
|
368
|
+
|
|
369
|
+
## 🎯 总结
|
|
370
|
+
|
|
371
|
+
**迁移状态**:✅ **已完成**
|
|
372
|
+
|
|
373
|
+
**修改范围**:
|
|
374
|
+
|
|
375
|
+
- ✅ 核心框架路由生成逻辑
|
|
376
|
+
- ✅ Admin 前端所有 API 调用
|
|
377
|
+
|
|
378
|
+
**验证结果**:
|
|
379
|
+
|
|
380
|
+
- ✅ 没有遗漏的 `/admin/` 路径
|
|
381
|
+
- ✅ 所有路径已更新为 `/addon/admin/`
|
|
382
|
+
|
|
383
|
+
**核心优势**:
|
|
384
|
+
|
|
385
|
+
- ✅ 彻底解决路由冲突
|
|
386
|
+
- ✅ 路径更清晰易读
|
|
387
|
+
- ✅ 符合命名空间最佳实践
|
|
388
|
+
- ✅ 扩展性更好
|
|
389
|
+
|
|
390
|
+
**后续工作**:
|
|
391
|
+
|
|
392
|
+
- 📋 测试所有功能
|
|
393
|
+
- 📋 更新项目文档
|
|
394
|
+
- 📋 更新 AGENTS.md 规范
|
|
395
|
+
|
|
396
|
+
---
|
|
397
|
+
|
|
398
|
+
**执行人**:AI Assistant
|
|
399
|
+
**完成时间**:2025-10-19
|
|
400
|
+
**状态**:✅ **迁移完成**
|