系统API接口文档
自动生成时间: 2025/8/25 09:45:10
📋 目录
- admin模块
- notice模块
- payConfig模块
- content模块
- dashboard模块
- data模块
- finance模块
- goods模块
- marketing模块
- order模块
- trade模块
- user模块
1. admin模块
文件路径: src\app\admin\api\index.js
account
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
user/list |
获取列表 |
CRUD |
| detail |
GET |
user/detail |
获取详情 |
CRUD |
| add |
POST |
user/add |
新增 |
CRUD |
| edit |
PUT |
user/update |
更新 |
CRUD |
| delete |
DELETE |
user/delete |
删除 |
CRUD |
options
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| logout |
GET |
admin/index/logout |
自定义接口 - logout |
Custom |
options
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| rules |
GET |
admin/index/rules |
自定义接口 - rules |
Custom |
admin
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
admin/auth/admin/list |
获取列表 |
CRUD |
| detail |
GET |
admin/auth/admin/detail |
获取详情 |
CRUD |
| add |
POST |
admin/auth/admin/add |
新增 |
CRUD |
| edit |
PUT |
admin/auth/admin/update |
更新 |
CRUD |
| delete |
DELETE |
admin/auth/admin/delete |
删除 |
CRUD |
user
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
user/list |
获取列表 |
CRUD |
| detail |
GET |
user/detail |
获取详情 |
CRUD |
| add |
POST |
user/add |
新增 |
CRUD |
| edit |
PUT |
user/update |
更新 |
CRUD |
| delete |
DELETE |
user/delete |
删除 |
CRUD |
role
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
role/list |
获取列表 |
CRUD |
| detail |
GET |
role/detail |
获取详情 |
CRUD |
| add |
POST |
role/add |
新增 |
CRUD |
| edit |
PUT |
role/update |
更新 |
CRUD |
| delete |
DELETE |
role/delete |
删除 |
CRUD |
access
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
permission/list |
获取列表 |
CRUD |
| detail |
GET |
permission/detail |
获取详情 |
CRUD |
| add |
POST |
permission/add |
新增 |
CRUD |
| edit |
PUT |
permission/update |
更新 |
CRUD |
| delete |
DELETE |
permission/delete |
删除 |
CRUD |
adminLog
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
admin/auth/adminLog/list |
获取列表 |
CRUD |
| detail |
GET |
admin/auth/adminLog/detail |
获取详情 |
CRUD |
| add |
POST |
admin/auth/adminLog/add |
新增 |
CRUD |
| edit |
PUT |
admin/auth/adminLog/update |
更新 |
CRUD |
| delete |
DELETE |
admin/auth/adminLog/delete |
删除 |
CRUD |
banner
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
/mall/banner/list |
获取列表 |
CRUD |
| detail |
GET |
/mall/banner/detail |
获取详情 |
CRUD |
| add |
POST |
/mall/banner/add |
新增 |
CRUD |
| edit |
PUT |
/mall/banner/update |
更新 |
CRUD |
| delete |
DELETE |
/mall/banner/delete |
删除 |
CRUD |
api
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| init |
GET |
admin/index/init |
自定义接口 - init |
Custom |
| loginConfig |
GET |
admin/index/loginConfig |
自定义接口 - loginConfig |
Custom |
| logout |
GET |
admin/index/logout |
自定义接口 - logout |
Custom |
| rules |
GET |
admin/index/rules |
自定义接口 - rules |
Custom |
2. notice模块
文件路径: src\app\notice\api\index.js
commonWord
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
chat/admin/commonWord/list |
获取列表 |
CRUD |
| detail |
GET |
chat/admin/commonWord/detail |
获取详情 |
CRUD |
| add |
POST |
chat/admin/commonWord/add |
新增 |
CRUD |
| edit |
PUT |
chat/admin/commonWord/update |
更新 |
CRUD |
| delete |
DELETE |
chat/admin/commonWord/delete |
删除 |
CRUD |
customerService
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
chat/admin/customerService/list |
获取列表 |
CRUD |
| detail |
GET |
chat/admin/customerService/detail |
获取详情 |
CRUD |
| add |
POST |
chat/admin/customerService/add |
新增 |
CRUD |
| edit |
PUT |
chat/admin/customerService/update |
更新 |
CRUD |
| delete |
DELETE |
chat/admin/customerService/delete |
删除 |
CRUD |
question
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
chat/admin/question/list |
获取列表 |
CRUD |
| detail |
GET |
chat/admin/question/detail |
获取详情 |
CRUD |
| add |
POST |
chat/admin/question/add |
新增 |
CRUD |
| edit |
PUT |
chat/admin/question/update |
更新 |
CRUD |
| delete |
DELETE |
chat/admin/question/delete |
删除 |
CRUD |
user
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
chat/admin/user/list |
获取列表 |
CRUD |
| detail |
GET |
chat/admin/user/detail |
获取详情 |
CRUD |
| add |
POST |
chat/admin/user/add |
新增 |
CRUD |
| edit |
PUT |
chat/admin/user/update |
更新 |
CRUD |
| delete |
DELETE |
chat/admin/user/delete |
删除 |
CRUD |
api
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| notificationType |
GET |
admin/notification/notificationType |
自定义接口 - notificationType |
Custom |
3. payConfig模块
文件路径: src\app\shop\admin\config\componenets\payConfig\payConfig.service.js
4. content模块
文件路径: src\app\shop\admin\content\content.service.js
5. dashboard模块
文件路径: src\app\shop\admin\dashboard\dashboard.service.js
6. data模块
文件路径: src\app\shop\admin\data\data.service.js
7. finance模块
文件路径: src\app\shop\admin\finance\finance.service.js
commission
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
/cif/red/envelope/list |
获取列表 |
CRUD |
| detail |
GET |
/cif/red/envelope/detail |
获取详情 |
CRUD |
| report |
GET |
/cif/red/envelope/report |
报表 |
CRUD |
recharge
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
cif/recharge/record/list |
获取列表 |
CRUD |
| detail |
GET |
cif/recharge/record/detail |
获取详情 |
CRUD |
| report |
GET |
cif/recharge/record/report |
报表 |
CRUD |
withdraw
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
/cif/withdraw/record/list |
获取列表 |
CRUD |
| detail |
GET |
/cif/withdraw/record/detail |
获取详情 |
CRUD |
| report |
GET |
/cif/withdraw/record/report |
报表 |
CRUD |
8. goods模块
文件路径: src\app\shop\admin\goods\goods.service.js
goods
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
mall/product/list |
获取列表 |
CRUD |
| detail |
GET |
mall/product/detail |
获取详情 |
CRUD |
| add |
POST |
mall/product/add |
新增 |
CRUD |
| edit |
PUT |
mall/product/update |
更新 |
CRUD |
| delete |
DELETE |
mall/product/delete |
删除 |
CRUD |
rule
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
mall/product/rule/list |
获取列表 |
CRUD |
| detail |
GET |
mall/product/rule/detail |
获取详情 |
CRUD |
| add |
POST |
mall/product/rule/add |
新增 |
CRUD |
| edit |
PUT |
mall/product/rule/update |
更新 |
CRUD |
| delete |
DELETE |
mall/product/rule/delete |
删除 |
CRUD |
category
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
mall/category/list |
获取列表 |
CRUD |
| detail |
GET |
mall/category/detail |
获取详情 |
CRUD |
| add |
POST |
mall/category/add |
新增 |
CRUD |
| edit |
PUT |
mall/category/update |
更新 |
CRUD |
| delete |
DELETE |
mall/category/delete |
删除 |
CRUD |
9. marketing模块
文件路径: src\app\shop\admin\marketing\marketing.service.js
group
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
mall/flash/activity/list |
获取列表 |
CRUD |
| detail |
GET |
mall/flash/activity/detail |
获取详情 |
CRUD |
| add |
POST |
mall/flash/activity/add |
新增 |
CRUD |
| edit |
PUT |
mall/flash/activity/update |
更新 |
CRUD |
| delete |
DELETE |
mall/flash/activity/delete |
删除 |
CRUD |
10. order模块
文件路径: src\app\shop\admin\order\order.service.js
order
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
mall/order/list |
获取列表 |
CRUD |
| detail |
GET |
mall/order/detail |
获取详情 |
CRUD |
| add |
POST |
mall/order/add |
新增 |
CRUD |
| edit |
PUT |
mall/order/update |
更新 |
CRUD |
| delete |
DELETE |
mall/order/delete |
删除 |
CRUD |
11. trade模块
文件路径: src\app\shop\admin\trade\trade.service.js
12. user模块
文件路径: src\app\shop\admin\user\user.service.js
list
| 接口名称 |
请求方法 |
接口地址 |
说明 |
类型 |
| list |
POST |
/cif/user/list |
获取列表 |
CRUD |
| detail |
GET |
/cif/user/detail |
获取详情 |
CRUD |
| edit |
PUT |
/cif/user/update |
更新 |
CRUD |
| delete |
DELETE |
/cif/user/delete |
删除 |
CRUD |
| report |
GET |
/cif/user/report |
报表 |
CRUD |
📊 统计信息
- 模块总数: 12
- 接口总数: 101
- 生成时间: 2025/8/25 09:45:10
