652 lines
23 KiB
Markdown
652 lines
23 KiB
Markdown
# 管理端 API 接口梳理报告
|
||
|
||
> 📅 更新日期：2025-12-26
|
||
> 📊 API 文件总数：95 个
|
||
> 📈 接口函数总数：约 420+ 个
|
||
|
||
---
|
||
|
||
## 一、API 概览
|
||
|
||
### 1.1 基础配置
|
||
| 配置项 | 值 |
|
||
|--------|-----|
|
||
| 基础URL | `SettingMer.apiBaseURL` |
|
||
| 超时时间 | 60000ms |
|
||
| 认证方式 | Header: `Authori-zation: token` |
|
||
| 响应格式 | `{ code: 200, data: {}, message: '' }` |
|
||
|
||
### 1.2 API 文件统计
|
||
| 模块分类 | 文件数 | 接口数(约) |
|
||
|----------|--------|-----------|
|
||
| 用户管理 | 2 | 35 |
|
||
| 直播房间 | 1 | 16 |
|
||
| 礼物管理 | 2 | 5 |
|
||
| 财务管理 | 12 | 45 |
|
||
| 内容管理 | 7 | 30 |
|
||
| 社交功能 | 10 | 25 |
|
||
| 装饰道具 | 7 | 30 |
|
||
| 运营活动 | 8 | 35 |
|
||
| 帮助反馈 | 5 | 15 |
|
||
| 代理管理 | 3 | 10 |
|
||
| 系统设置 | 18 | 80 |
|
||
| 微信相关 | 1 | 35 |
|
||
| 其他模块 | 19 | 60 |
|
||
| **合计** | **95** | **420+** |
|
||
|
||
---
|
||
|
||
## 二、API 文件完整清单
|
||
|
||
### 2.1 用户管理 (2个文件)
|
||
| 文件名 | 接口数 | 主要功能 |
|
||
|--------|--------|----------|
|
||
| `user.js` | 30 | 用户CRUD、等级、标签、分组、登录认证 |
|
||
| `userDynamic.js` | 5 | 用户动态、评论管理 |
|
||
|
||
### 2.2 直播房间 (1个文件)
|
||
| 文件名 | 接口数 | 主要功能 |
|
||
|--------|--------|----------|
|
||
| `room.js` | 16 | 房间管理、类型管理、背景图管理 |
|
||
|
||
### 2.3 礼物管理 (2个文件)
|
||
| 文件名 | 接口数 | 主要功能 |
|
||
|--------|--------|----------|
|
||
| `giftDetail.js` | 2 | 送礼明细 |
|
||
| `giftRewardRecord.js` | 3 | 打赏记录 |
|
||
|
||
### 2.4 财务管理 (12个文件)
|
||
| 文件名 | 接口数 | 主要功能 |
|
||
|--------|--------|----------|
|
||
| `financial.js` | 11 | 提现申请、充值、资金监控 |
|
||
| `financialOrder.js` | 3 | 财务订单 |
|
||
| `withdraw.js` | 3 | 提现管理 |
|
||
| `withdrawAmount.js` | 6 | 提现金额配置 |
|
||
| `withdrawPending.js` | 4 | 待审核提现 |
|
||
| `withdrawApproved.js` | 2 | 已审核提现 |
|
||
| `coinDetail.js` | 2 | 金币明细 |
|
||
| `diamondDetail.js` | 2 | 钻石明细 |
|
||
| `charmDetail.js` | 2 | 魅力值明细 |
|
||
| `exchangeDetail.js` | 2 | 兑换明细 |
|
||
| `exchangeRecord.js` | 2 | 兑换记录 |
|
||
| `goldDiamondConfig.js` | 4 | 金币钻石配置 |
|
||
|
||
### 2.5 内容管理 (7个文件)
|
||
| 文件名 | 接口数 | 主要功能 |
|
||
|--------|--------|----------|
|
||
| `dynamic.js` | 4 | 动态管理 |
|
||
| `article.js` | 5 | 文章管理 |
|
||
| `banner.js` | 6 | 轮播图管理 |
|
||
| `sensitiveWord.js` | 5 | 敏感词管理 |
|
||
| `systemMessage.js` | 5 | 系统消息 |
|
||
| `chatPhrase.js` | 5 | 聊天常用语 |
|
||
| `comment.js` | 6 | 评论管理 |
|
||
|
||
### 2.6 社交功能 (10个文件)
|
||
| 文件名 | 接口数 | 主要功能 |
|
||
|--------|--------|----------|
|
||
| `familyList.js` | 2 | 家族列表 |
|
||
| `familyLevel.js` | 5 | 家族等级 |
|
||
| `familyMember.js` | 3 | 家族成员 |
|
||
| `fanGroup.js` | 2 | 粉丝团 |
|
||
| `fans.js` | 4 | 粉丝管理 |
|
||
| `followRecord.js` | 1 | 关注记录 |
|
||
| `blacklist.js` | 4 | 黑名单管理 |
|
||
| `session.js` | 3 | 会话管理 |
|
||
| `matchText.js` | 2 | 匹配文本 |
|
||
| `socialDynamic.js` | 7 | 社交动态 |
|
||
|
||
### 2.7 装饰道具 (7个文件)
|
||
| 文件名 | 接口数 | 主要功能 |
|
||
|--------|--------|----------|
|
||
| `mount.js` | 5 | 坐骑管理 |
|
||
| `mountList.js` | 2 | 坐骑列表 |
|
||
| `mountOrder.js` | 2 | 坐骑订单 |
|
||
| `mountPurchaseRecord.js` | 2 | 坐骑购买记录 |
|
||
| `headwear.js` | 5 | 头饰管理 |
|
||
| `charmLevel.js` | 5 | 魅力等级 |
|
||
| `nobleLevel.js` | 5 | 贵族等级 |
|
||
|
||
### 2.8 运营活动 (8个文件)
|
||
| 文件名 | 接口数 | 主要功能 |
|
||
|--------|--------|----------|
|
||
| `lotteryPrize.js` | 7 | 抽奖奖品 |
|
||
| `lotteryProbability.js` | 5 | 抽奖概率 |
|
||
| `noviceTask.js` | 4 | 新手任务 |
|
||
| `invite.js` | 2 | 邀请管理 |
|
||
| `platformActivity.js` | 5 | 平台活动 |
|
||
| `marketing.js` | 4 | 营销管理 |
|
||
| `distribution.js` | 5 | 分销管理 |
|
||
| `sign.js` | 3 | 签到管理 |
|
||
|
||
### 2.9 帮助反馈 (5个文件)
|
||
| 文件名 | 接口数 | 主要功能 |
|
||
|--------|--------|----------|
|
||
| `feedback.js` | 1 | 用户反馈 |
|
||
| `report.js` | 2 | 举报管理 |
|
||
| `reportList.js` | 2 | 举报列表 |
|
||
| `appeal.js` | 4 | 申诉管理 |
|
||
| `customerService.js` | 5 | 客服联系方式 |
|
||
|
||
### 2.10 代理管理 (3个文件)
|
||
| 文件名 | 接口数 | 主要功能 |
|
||
|--------|--------|----------|
|
||
| `agent.js` | 4 | 代理管理 |
|
||
| `agentMessage.js` | 3 | 代理消息 |
|
||
| `agentWithdraw.js` | 3 | 代理提现 |
|
||
|
||
### 2.11 系统设置 (18个文件)
|
||
| 文件名 | 接口数 | 主要功能 |
|
||
|--------|--------|----------|
|
||
| `system.js` | 7 | 附件分类、图片管理 |
|
||
| `systemConfig.js` | 14 | 系统配置 |
|
||
| `systemSetting.js` | 8 | 文件上传、图片管理 |
|
||
| `systemFormConfig.js` | 12 | 表单配置、通知管理 |
|
||
| `systemGroup.js` | 10 | 系统分组、页面设计 |
|
||
| `systemGroupData.js` | 5 | 分组数据 |
|
||
| `systemVersion.js` | 5 | 版本管理 |
|
||
| `systemadmin.js` | 14 | 管理员、菜单权限 |
|
||
| `role.js` | 6 | 角色管理 |
|
||
| `roleApi.js` | 2 | 角色详情、菜单 |
|
||
| `schedule.js` | 4 | 定时任务 |
|
||
| `sms.js` | 3 | 短信配置 |
|
||
| `logistics.js` | 14 | 城市、物流、运费模板 |
|
||
| `configApi.js` | 3 | 配置API |
|
||
| `configTabApi.js` | 5 | 配置Tab管理 |
|
||
| `categoryApi.js` | 5 | 分类API |
|
||
| `storePoint.js` | 14 | 提货点、核销员 |
|
||
| `customerServiceGroup.js` | 4 | 客服分组 |
|
||
|
||
### 2.12 微信相关 (1个文件)
|
||
| 文件名 | 接口数 | 主要功能 |
|
||
|--------|--------|----------|
|
||
| `wxApi.js` | 35 | 微信菜单、模板消息、关键字回复、小程序 |
|
||
|
||
### 2.13 其他模块 (19个文件)
|
||
| 文件名 | 接口数 | 主要功能 |
|
||
|--------|--------|----------|
|
||
| `req.js` | 1 | 请求基础封装 |
|
||
| `dashboard.js` | 3 | 仪表盘数据 |
|
||
| `statistic.js` | 5 | 统计数据 |
|
||
| `order.js` | 8 | 订单管理 |
|
||
| `orderManage.js` | 5 | 订单管理扩展 |
|
||
| `store.js` | 10 | 商品管理 |
|
||
| `devise.js` | 1 | 装修设计列表 |
|
||
| `pagediy.js` | 8 | 页面DIY |
|
||
| `authInformation.js` | 3 | 认证信息 |
|
||
| `carAuth.js` | 4 | 车辆认证 |
|
||
| `certification.js` | 4 | 认证管理 |
|
||
| `chat.js` | 5 | 聊天管理 |
|
||
| `chatPayConfig.js` | 5 | 聊天付费配置 |
|
||
| `memberPackage.js` | 5 | 会员套餐 |
|
||
| `purchaseDetail.js` | 2 | 购买明细 |
|
||
| `receiveGiftDetail.js` | 2 | 收礼明细 |
|
||
| `rechargeOrder.js` | 3 | 充值订单 |
|
||
| `liveRecharge.js` | 3 | 直播充值 |
|
||
| `diamondRechargeAmount.js` | 5 | 钻石充值金额 |
|
||
|
||
---
|
||
|
||
## 三、核心 API 接口详情
|
||
|
||
### 3.1 用户管理 (user.js)
|
||
```javascript
|
||
// 登录认证
|
||
login(data) // POST /admin/login
|
||
getInfo(token) // GET /admin/getAdminInfoByToken
|
||
logout() // GET /admin/logout
|
||
captchaApi() // GET /admin/validate/code/get
|
||
getLoginPicApi() // GET /admin/getLoginPic
|
||
|
||
// 用户CRUD
|
||
userListApi(params) // GET /admin/user/list
|
||
userUpdateApi(params, data) // POST /admin/user/update
|
||
userInfoApi(params) // GET /admin/user/info
|
||
userDeleteApi(params) // GET /admin/user/delete
|
||
userLevelUpdateApi(data) // POST /admin/user/update/level
|
||
|
||
// 用户等级
|
||
levelListApi() // GET /admin/system/user/level/list
|
||
levelSaveApi(data) // POST /admin/system/user/level/save
|
||
levelUpdateApi(params, data) // POST /admin/system/user/level/update/{id}
|
||
levelDeleteApi(id) // POST /admin/system/user/level/delete/{id}
|
||
|
||
// 用户标签
|
||
tagListApi(params) // GET /admin/user/tag/list
|
||
tagSaveApi(data) // POST /admin/user/tag/save
|
||
tagUpdateApi(params, data) // POST /admin/user/tag/update
|
||
tagDeleteApi(params) // GET /admin/user/tag/delete
|
||
|
||
// 用户分组
|
||
groupListApi(params) // GET /admin/user/group/list
|
||
groupSaveApi(data) // POST /admin/user/group/save
|
||
groupUpdateApi(params, data) // POST /admin/user/group/update
|
||
groupDeleteApi(params) // GET /admin/user/group/delete
|
||
```
|
||
|
||
### 3.2 直播房间 (room.js)
|
||
```javascript
|
||
// 房间管理
|
||
roomListApi(params) // GET /admin/room/live/list
|
||
liveRoomCreateApi(data) // POST /admin/room/live/create
|
||
liveRoomUpdateApi(data) // POST /admin/room/live/update
|
||
liveRoomDeleteApi(id) // POST /admin/room/live/delete/{id}
|
||
liveRoomToggleStatusApi(id, data) // POST /admin/room/live/toggle-status/{id}
|
||
liveRoomChatHistoryApi(roomId, params) // GET /admin/room/live/chat/{roomId}
|
||
roomDetailApi(id) // GET /admin/room/detail/{id}
|
||
|
||
// 房间类型
|
||
roomTypeListApi(params) // GET /admin/room/type/list
|
||
roomTypeCreateApi(data) // POST /admin/room/type/create
|
||
roomTypeUpdateApi(data) // POST /admin/room/type/update
|
||
roomTypeDeleteApi(id) // POST /admin/room/type/delete/{id}
|
||
roomTypeStatusApi(data) // POST /admin/room/type/updateStatus
|
||
|
||
// 房间背景
|
||
roomBackgroundListApi(params) // GET /admin/room/background/list
|
||
roomBackgroundCreateApi(data) // POST /admin/room/background/create
|
||
roomBackgroundUpdateApi(data) // POST /admin/room/background/update
|
||
roomBackgroundDeleteApi(id) // POST /admin/room/background/delete/{id}
|
||
```
|
||
|
||
### 3.3 财务管理 (financial.js)
|
||
```javascript
|
||
// 提现申请
|
||
applyListApi(params) // GET /admin/finance/apply/list
|
||
applyBalanceApi(data) // POST /admin/finance/apply/balance
|
||
applyUpdateApi(data) // POST /admin/finance/apply/update
|
||
applyStatusApi(data) // POST /admin/finance/apply/apply
|
||
|
||
// 充值管理
|
||
topUpLogListApi(params) // GET /admin/user/topUpLog/list
|
||
balanceApi(data) // POST /admin/user/topUpLog/balance
|
||
topUpLogDeleteApi(params) // GET /admin/user/topUpLog/delete
|
||
refundApi(data) // POST /admin/user/topUpLog/refund
|
||
|
||
// 资金监控
|
||
monitorListApi(params) // GET /admin/finance/founds/monitor/list
|
||
monitorListOptionApi() // GET /admin/finance/founds/monitor/list/option
|
||
brokerageListApi(params) // GET /admin/finance/founds/monitor/brokerage/record
|
||
```
|
||
|
||
### 3.4 系统管理 (systemadmin.js)
|
||
```javascript
|
||
// 管理员
|
||
adminList(params) // GET /admin/system/admin/list
|
||
adminAdd(pram) // POST /admin/system/admin/save
|
||
adminUpdate(pram) // POST /admin/system/admin/update
|
||
adminDel(pram) // GET /admin/system/admin/delete
|
||
adminInfo(pram) // GET /admin/system/admin/info
|
||
updateStatusApi(params) // GET /admin/system/admin/updateStatus
|
||
|
||
// 菜单权限
|
||
menuListApi(params) // GET /admin/system/menu/list
|
||
menuAdd(data) // POST /admin/system/menu/add
|
||
menuUpdate(data) // POST /admin/system/menu/update
|
||
menuDelete(id) // POST /admin/system/menu/delete/{id}
|
||
menuInfo(id) // GET /admin/system/menu/info/{id}
|
||
menuUpdateShowStatus(params) // POST /admin/system/menu/updateShowStatus
|
||
|
||
// 敏感操作日志
|
||
sensitiveListApi(params) // GET /admin/log/sensitive/list
|
||
```
|
||
|
||
### 3.5 系统配置 (systemConfig.js)
|
||
```javascript
|
||
configCheckUnique(params) // GET /admin/system/config/check
|
||
configDelete(params) // GET /admin/system/config/delete
|
||
configInfo(params) // GET /admin/system/config/info
|
||
configList(params) // GET /admin/system/config/list
|
||
configSave(data) // POST /admin/system/config/save
|
||
configSaveForm(data) // POST /admin/system/config/save/form
|
||
configUpdate(data) // POST /admin/system/config/update
|
||
getSiteLogoApi() // GET /admin/system/config/get/site/logo
|
||
getUploadTypeApi() // GET /admin/system/config/get/upload/type
|
||
clearCacheApi() // POST /admin/system/config/clear/cache
|
||
changeColorApi() // GET /admin/system/config/get/change/color
|
||
saveColorApi(data) // POST /admin/system/config/save/change/color
|
||
getParamsListApi(params) // GET /admin/system/config/params/list
|
||
saveParamsApi(data) // POST /admin/system/config/params/save
|
||
```
|
||
|
||
### 3.6 角色管理 (role.js)
|
||
```javascript
|
||
getRoleList(pram) // GET /admin/system/role/list
|
||
addRole(pram) // POST /admin/system/role/save
|
||
updateRole(pram) // POST /admin/system/role/update
|
||
delRole(pram) // GET /admin/system/role/delete
|
||
getInfo(pram) // GET /admin/system/role/info/{id}
|
||
updateRoleStatus(pram) // GET /admin/system/role/updateStatus
|
||
menuCacheList() // GET /admin/system/menu/cache/tree
|
||
```
|
||
|
||
### 3.7 微信相关 (wxApi.js)
|
||
```javascript
|
||
// 微信菜单
|
||
menuCreate(data) // POST /admin/wechat/menu/public/create
|
||
menuDelete(data) // POST /admin/wechat/menu/public/delete
|
||
menuInfo(pram) // POST /admin/wechat/menu/public/get
|
||
wechatMenuApi(params) // GET /admin/wechat/menu/public/get
|
||
wechatMenuAddApi(data) // POST /admin/wechat/menu/public/create
|
||
|
||
// 微信模板消息
|
||
wechatTemplateListApi(params) // GET /admin/wechat/template/list
|
||
wechatTemplateSaveApi(data) // POST /admin/wechat/template/save
|
||
wechatTemplateUpdateApi(id, data) // POST /admin/wechat/template/update/{id}
|
||
wechatTemplateDeleteApi(id) // GET /admin/wechat/template/delete/{id}
|
||
wechatTemplateStatusApi(id, params) // POST /admin/wechat/template/update/status/{id}
|
||
|
||
// 关键字回复
|
||
replyListApi(params) // GET /admin/wechat/keywords/reply/list
|
||
replySaveApi(data) // POST /admin/wechat/keywords/reply/save
|
||
replyUpdateApi(params, data) // POST /admin/wechat/keywords/reply/update
|
||
replyDeleteApi(params) // GET /admin/wechat/keywords/reply/delete
|
||
replyStatusApi(params) // POST /admin/wechat/keywords/reply/status
|
||
|
||
// 小程序模板
|
||
publicTempListApi(params) // GET /admin/wechat/program/public/temp/list
|
||
myTempListApi(params) // GET /admin/wechat/program/my/temp/list
|
||
myTempSaveApi(data) // POST /admin/wechat/program/my/temp/save
|
||
myTempUpdateApi(params, data) // POST /admin/wechat/program/my/temp/update
|
||
myTempStatusApi(params) // GET /admin/wechat/program/my/temp/update/status
|
||
tempAsyncApi() // GET /admin/wechat/program/my/temp/async
|
||
```
|
||
|
||
---
|
||
|
||
## 四、API 目录结构
|
||
|
||
```
|
||
src/api/
|
||
├── 用户管理
|
||
│ ├── user.js # 用户、等级、标签、分组、登录
|
||
│ └── userDynamic.js # 用户动态、评论
|
||
│
|
||
├── 直播相关
|
||
│ ├── room.js # 房间、类型、背景图
|
||
│ ├── giftDetail.js # 送礼明细
|
||
│ └── giftRewardRecord.js # 打赏记录
|
||
│
|
||
├── 财务管理
|
||
│ ├── financial.js # 提现申请、充值、资金监控
|
||
│ ├── financialOrder.js # 财务订单
|
||
│ ├── withdraw.js # 提现管理
|
||
│ ├── withdrawAmount.js # 提现金额配置
|
||
│ ├── withdrawPending.js # 待审核提现
|
||
│ ├── withdrawApproved.js # 已审核提现
|
||
│ ├── coinDetail.js # 金币明细
|
||
│ ├── diamondDetail.js # 钻石明细
|
||
│ ├── charmDetail.js # 魅力值明细
|
||
│ ├── exchangeDetail.js # 兑换明细
|
||
│ ├── exchangeRecord.js # 兑换记录
|
||
│ └── goldDiamondConfig.js # 金币钻石配置
|
||
│
|
||
├── 内容管理
|
||
│ ├── dynamic.js # 动态管理
|
||
│ ├── article.js # 文章管理
|
||
│ ├── banner.js # 轮播图
|
||
│ ├── sensitiveWord.js # 敏感词
|
||
│ ├── systemMessage.js # 系统消息
|
||
│ ├── chatPhrase.js # 聊天常用语
|
||
│ └── comment.js # 评论管理
|
||
│
|
||
├── 社交功能
|
||
│ ├── familyList.js # 家族列表
|
||
│ ├── familyLevel.js # 家族等级
|
||
│ ├── familyMember.js # 家族成员
|
||
│ ├── fanGroup.js # 粉丝团
|
||
│ ├── fans.js # 粉丝管理
|
||
│ ├── followRecord.js # 关注记录
|
||
│ ├── blacklist.js # 黑名单
|
||
│ ├── session.js # 会话管理
|
||
│ ├── matchText.js # 匹配文本
|
||
│ └── socialDynamic.js # 社交动态
|
||
│
|
||
├── 装饰道具
|
||
│ ├── mount.js # 坐骑管理
|
||
│ ├── mountList.js # 坐骑列表
|
||
│ ├── mountOrder.js # 坐骑订单
|
||
│ ├── mountPurchaseRecord.js # 坐骑购买记录
|
||
│ ├── headwear.js # 头饰管理
|
||
│ ├── charmLevel.js # 魅力等级
|
||
│ └── nobleLevel.js # 贵族等级
|
||
│
|
||
├── 运营活动
|
||
│ ├── lotteryPrize.js # 抽奖奖品
|
||
│ ├── lotteryProbability.js # 抽奖概率
|
||
│ ├── noviceTask.js # 新手任务
|
||
│ ├── invite.js # 邀请管理
|
||
│ ├── platformActivity.js # 平台活动
|
||
│ ├── marketing.js # 营销管理
|
||
│ ├── distribution.js # 分销管理
|
||
│ └── sign.js # 签到管理
|
||
│
|
||
├── 帮助反馈
|
||
│ ├── feedback.js # 用户反馈
|
||
│ ├── report.js # 举报管理
|
||
│ ├── reportList.js # 举报列表
|
||
│ ├── appeal.js # 申诉管理
|
||
│ └── customerService.js # 客服联系方式
|
||
│
|
||
├── 代理管理
|
||
│ ├── agent.js # 代理管理
|
||
│ ├── agentMessage.js # 代理消息
|
||
│ └── agentWithdraw.js # 代理提现
|
||
│
|
||
├── 系统设置
|
||
│ ├── system.js # 附件分类
|
||
│ ├── systemConfig.js # 系统配置
|
||
│ ├── systemSetting.js # 文件上传
|
||
│ ├── systemFormConfig.js # 表单配置、通知
|
||
│ ├── systemGroup.js # 系统分组
|
||
│ ├── systemGroupData.js # 分组数据
|
||
│ ├── systemVersion.js # 版本管理
|
||
│ ├── systemadmin.js # 管理员、菜单
|
||
│ ├── role.js # 角色管理
|
||
│ ├── roleApi.js # 角色API
|
||
│ ├── schedule.js # 定时任务
|
||
│ ├── sms.js # 短信配置
|
||
│ ├── logistics.js # 物流配置
|
||
│ ├── configApi.js # 配置API
|
||
│ ├── configTabApi.js # 配置Tab
|
||
│ ├── categoryApi.js # 分类API
|
||
│ ├── storePoint.js # 提货点
|
||
│ └── customerServiceGroup.js # 客服分组
|
||
│
|
||
├── 微信相关
|
||
│ └── wxApi.js # 微信菜单、模板、小程序
|
||
│
|
||
└── 其他
|
||
├── req.js # 请求封装
|
||
├── dashboard.js # 仪表盘
|
||
├── statistic.js # 统计
|
||
├── order.js # 订单
|
||
├── orderManage.js # 订单管理
|
||
├── store.js # 商品
|
||
├── devise.js # 装修设计
|
||
├── pagediy.js # 页面DIY
|
||
├── authInformation.js # 认证信息
|
||
├── carAuth.js # 车辆认证
|
||
├── certification.js # 认证管理
|
||
├── chat.js # 聊天
|
||
├── chatPayConfig.js # 聊天付费
|
||
├── memberPackage.js # 会员套餐
|
||
├── purchaseDetail.js # 购买明细
|
||
├── receiveGiftDetail.js # 收礼明细
|
||
├── rechargeOrder.js # 充值订单
|
||
├── liveRecharge.js # 直播充值
|
||
└── diamondRechargeAmount.js # 钻石充值
|
||
```
|
||
|
||
|
||
---
|
||
|
||
## 五、API 设计规范
|
||
|
||
### 5.1 URL 命名规范
|
||
```
|
||
/admin/{模块}/{资源}/{操作}
|
||
|
||
示例：
|
||
/admin/user/list # 用户列表
|
||
/admin/user/update # 更新用户
|
||
/admin/user/delete/{id} # 删除用户
|
||
/admin/room/type/list # 房间类型列表
|
||
/admin/system/config/save # 保存配置
|
||
```
|
||
|
||
### 5.2 请求方法规范
|
||
| 操作类型 | HTTP方法 | URL示例 |
|
||
|----------|----------|---------|
|
||
| 查询列表 | GET | `/admin/user/list` |
|
||
| 查询详情 | GET | `/admin/user/info/{id}` |
|
||
| 新增数据 | POST | `/admin/user/save` |
|
||
| 更新数据 | POST | `/admin/user/update` |
|
||
| 删除数据 | GET/POST | `/admin/user/delete/{id}` |
|
||
| 切换状态 | POST | `/admin/user/updateStatus` |
|
||
|
||
### 5.3 响应格式规范
|
||
|
||
**成功响应**
|
||
```json
|
||
{
|
||
"code": 200,
|
||
"data": {},
|
||
"message": "success"
|
||
}
|
||
```
|
||
|
||
**列表响应**
|
||
```json
|
||
{
|
||
"code": 200,
|
||
"data": {
|
||
"list": [],
|
||
"total": 100
|
||
},
|
||
"message": "success"
|
||
}
|
||
```
|
||
|
||
**错误响应**
|
||
```json
|
||
{
|
||
"code": 401,
|
||
"data": null,
|
||
"message": "错误信息"
|
||
}
|
||
```
|
||
|
||
> 错误码：401-未授权, 403-无权限, 500-服务器错误
|
||
|
||
### 5.4 分页参数规范
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| page | number | 当前页码 |
|
||
| limit | number | 每页条数 |
|
||
| keywords | string | 搜索关键词 |
|
||
| status | string | 状态筛选 |
|
||
| startTime | string | 开始时间 |
|
||
| endTime | string | 结束时间 |
|
||
|
||
---
|
||
|
||
## 六、API 使用示例
|
||
|
||
### 6.1 常用导入
|
||
```javascript
|
||
// 用户管理
|
||
import { userListApi, userUpdateApi, userDeleteApi } from '@/api/user'
|
||
|
||
// 房间管理
|
||
import { roomListApi, roomTypeListApi } from '@/api/room'
|
||
|
||
// 财务管理
|
||
import { withdrawListApi, withdrawAuditApi } from '@/api/withdraw'
|
||
|
||
// 系统配置
|
||
import { configList, clearCacheApi } from '@/api/systemConfig'
|
||
|
||
// 角色管理
|
||
import { getRoleList, addRole, updateRole } from '@/api/role'
|
||
```
|
||
|
||
### 6.2 调用示例
|
||
```javascript
|
||
// 列表查询
|
||
const params = { page: 1, limit: 10, keywords: '' }
|
||
const res = await userListApi(params)
|
||
// res.data = { list: [...], total: 100 }
|
||
|
||
// 新增数据
|
||
const data = { name: 'xxx', status: 1 }
|
||
await userSaveApi(data)
|
||
|
||
// 更新数据
|
||
const data = { id: 1, name: 'xxx' }
|
||
await userUpdateApi(data)
|
||
|
||
// 删除数据
|
||
await userDeleteApi({ id: 1 })
|
||
```
|
||
|
||
---
|
||
|
||
## 七、问题与优化建议
|
||
|
||
### 7.1 命名不一致问题
|
||
| 问题 | 现状 | 建议 |
|
||
|------|------|------|
|
||
| 删除方法不一致 | GET/POST 混用 | 统一使用 POST |
|
||
| 列表命名不一致 | `list`/`lst` 混用 | 统一使用 `list` |
|
||
| 详情命名不一致 | `info`/`detail` 混用 | 统一使用 `detail` |
|
||
| 新增命名不一致 | `save`/`create`/`add` 混用 | 统一使用 `create` |
|
||
|
||
### 7.2 重复文件建议合并
|
||
| 文件组 | 建议 |
|
||
|--------|------|
|
||
| `report.js` + `reportList.js` | 合并为 `report.js` |
|
||
| `mount.js` + `mountList.js` | 合并为 `mount.js` |
|
||
| `role.js` + `roleApi.js` | 合并为 `role.js` |
|
||
|
||
### 7.3 建议统一命名规范
|
||
```javascript
|
||
// 推荐命名格式
|
||
xxxListApi() // 列表
|
||
xxxDetailApi() // 详情
|
||
xxxCreateApi() // 新增
|
||
xxxUpdateApi() // 更新
|
||
xxxDeleteApi() // 删除
|
||
xxxStatusApi() // 状态切换
|
||
```
|
||
|
||
---
|
||
|
||
## 八、统计汇总
|
||
|
||
### 8.1 按操作类型统计
|
||
| 操作类型 | 数量(约) | 占比 |
|
||
|----------|---------|------|
|
||
| 列表查询 | 95 | 23% |
|
||
| 详情查询 | 45 | 11% |
|
||
| 新增操作 | 55 | 13% |
|
||
| 更新操作 | 70 | 17% |
|
||
| 删除操作 | 55 | 13% |
|
||
| 状态切换 | 35 | 8% |
|
||
| 其他操作 | 65 | 15% |
|
||
| **合计** | **420** | **100%** |
|
||
|
||
### 8.2 新增API模块 (2025-12-26)
|
||
| 文件名 | 接口数 | 说明 |
|
||
|--------|--------|------|
|
||
| `appeal.js` | 4 | 申诉管理 |
|
||
| `certification.js` | 4 | 认证管理 |
|
||
| `fans.js` | 4 | 粉丝管理 |
|
||
| `comment.js` | 6 | 评论管理 |
|
||
| `socialDynamic.js` | 7 | 社交动态 |
|
||
|
||
---
|
||
|
||
*报告生成完毕*
|