docs: 添加AGENTS开发指南和API接口文档
This commit is contained in:
huacracker
233
docs/API.md
Normal file
233
docs/API.md
Normal file
@@ -0,0 +1,233 @@
|
||||
# XGT 系统接口列表
|
||||
|
||||
## 一、公共接口 (ruoyi-admin)
|
||||
|
||||
### 1. 认证相关 `/auth`
|
||||
| 方法 | 路径 | 说明 |
|
||||
|------|------|------|
|
||||
| POST | `/auth/login` | 登录 |
|
||||
| POST | `/auth/logout` | 登出 |
|
||||
| POST | `/auth/register` | 注册 |
|
||||
| GET | `/auth/tenant/list` | 租户列表 |
|
||||
| GET | `/auth/code` | 验证码 |
|
||||
|
||||
### 2. 首页 `/`
|
||||
| 方法 | 路径 | 说明 |
|
||||
|------|------|------|
|
||||
| GET | `/` | 欢迎页 |
|
||||
| GET | `/banner` | 画册列表 |
|
||||
| GET | `/banner/{id}` | 画册详情 |
|
||||
| GET | `/prod` | 商品列表 |
|
||||
| GET | `/prod/{id}` | 商品详情 |
|
||||
| GET | `/tpSysUser` | 表现师列表 |
|
||||
| GET | `/sysUser/{id}` | 用户详情 |
|
||||
| GET | `/follow` | 关注列表 |
|
||||
| POST | `/AddFollow` | 关注 |
|
||||
| DELETE | `/delFollow` | 取消关注 |
|
||||
| POST | `/isFollow` | 是否关注 |
|
||||
| GET | `/tpWorks` | 作品列表 |
|
||||
| POST | `/AddWorks` | 收藏作品 |
|
||||
| DELETE | `/delWorks` | 取消收藏 |
|
||||
| POST | `/isWorks` | 是否收藏 |
|
||||
| POST | `/wx/jssdk` | 微信JSSDK签名 |
|
||||
|
||||
### 3. 首页统计 `/`
|
||||
| 方法 | 路径 | 说明 |
|
||||
|------|------|------|
|
||||
| GET | `/indexSum` | 首页统计 |
|
||||
| GET | `/rankingListKF` | 客服排行 |
|
||||
| GET | `/rankingListKFSum` | 客服统计 |
|
||||
| GET | `/rankingListJS` | 技术排行 |
|
||||
| GET | `/rankingListJSSum` | 技术统计 |
|
||||
| GET | `/deptRankingList` | 客服部排行 |
|
||||
| GET | `/deptRankingList1` | 客服部排行(单) |
|
||||
| GET | `/deptRankingJSList` | 技术部排行 |
|
||||
| GET | `/deptRankingJSList1` | 技术部排行(单) |
|
||||
| GET | `/khRankingList` | 客户下单排行 |
|
||||
| GET | `/khRankingListSum` | 客户下单统计 |
|
||||
| GET | `/kfDayList` | 客服数据分析(日) |
|
||||
| GET | `/wxDayList` | 微信好友分析(日) |
|
||||
| GET | `/wxDayList1` | 微信好友分析(日) |
|
||||
| GET | `/wxMonthList` | 微信好友分析(月) |
|
||||
| GET | `/ftDayList` | 技术部分图(日) |
|
||||
| GET | `/jsDayList` | 技术部月报 |
|
||||
| POST | `/monthArrivedPer` | 月业绩统计 |
|
||||
| POST | `/yearArrivedPer` | 年业绩统计 |
|
||||
| POST | `/monthOrderType` | 订单类型统计 |
|
||||
| POST | `/monthOrderSpace` | 订单空间统计 |
|
||||
| POST | `/monthOrderStyle` | 订单风格统计 |
|
||||
| POST | `/newOldOrderPer` | 新老客户占比 |
|
||||
| POST | `/notifyCheckSign` | 银盛支付回调 |
|
||||
| POST | `/updateOrder` | 更新订单部门状态 |
|
||||
|
||||
---
|
||||
|
||||
## 二、业务模块 (ruoyi-work)
|
||||
|
||||
### 订单模块 `/work/order*`
|
||||
| 控制器 | 路径 | 说明 |
|
||||
|--------|------|------|
|
||||
| TpOrderController | `/work/order` | 订单管理 |
|
||||
| CustomerOrderController | `/work/customer/order` | 客户订单 |
|
||||
| SkillOrderController | `/work/skill/order` | 技术订单 |
|
||||
| TpOrderBigController | `/work/orderBig` | 大图订单 |
|
||||
| TpOrderSmallController | `/work/orderSmall` | 小图订单 |
|
||||
| TpOrderCdController | `/work/orderCd` | 拆单记录 |
|
||||
| TpOrderRecordController | `/work/orderRecord` | 操作记录 |
|
||||
| TpOrderPayController | `/work/orderPay` | 支付记录 |
|
||||
| TpOrderCommentController | `/work/orderComment` | 订单评价 |
|
||||
| TpOrderModelController | `/work/orderModel` | 订单模板 |
|
||||
|
||||
#### CustomerOrderController 详细接口
|
||||
| 方法 | 路径 | 说明 |
|
||||
|------|------|------|
|
||||
| GET | `/work/customer/order/list` | 客户订单列表 |
|
||||
| GET | `/work/customer/order/sum` | 客户订单统计 |
|
||||
| POST | `/work/customer/order/export` | 导出客户订单 |
|
||||
| GET | `/work/customer/order/{id}` | 客户订单详情 |
|
||||
| POST | `/work/customer/order` | 新增客户订单 |
|
||||
| PUT | `/work/customer/order` | 更新客户订单 |
|
||||
| DELETE | `/work/customer/order/{ids}` | 删除客户订单 |
|
||||
| POST | `/work/customer/order/assign` | 派单 |
|
||||
| POST | `/work/customer/order/cancelAssign` | 取消派单 |
|
||||
| GET | `/work/customer/order/queryOrderPay/{orderId}` | 查询支付信息 |
|
||||
| POST | `/work/customer/order/pay` | 支付 |
|
||||
| GET | `/work/customer/order/orderFallback/{orderId}` | 退款信息 |
|
||||
| POST | `/work/customer/order/fallback` | 退款 |
|
||||
| GET | `/work/customer/order/cdOrderInfo/{orderId}` | 拆单信息 |
|
||||
| POST | `/work/customer/order/cdOrder` | 拆单 |
|
||||
| GET | `/work/customer/order/gjOrderInfo/{orderId}` | 改价信息 |
|
||||
| POST | `/work/customer/order/gjOrder` | 改价 |
|
||||
|
||||
### 客户模块 `/work/client*`
|
||||
| 控制器 | 路径 | 说明 |
|
||||
|--------|------|------|
|
||||
| TpClientController | `/work/client` | 客户管理 |
|
||||
| TpClientStaffController | `/work/clientStaff` | 客服客户 |
|
||||
| TpClientFundController | `/work/clientFund` | 客户资金 |
|
||||
|
||||
#### TpClientController 详细接口
|
||||
| 方法 | 路径 | 说明 |
|
||||
|------|------|------|
|
||||
| GET | `/work/client/list` | 客户列表 |
|
||||
| GET | `/work/client/listChart` | 客户订单统计 |
|
||||
| POST | `/work/client/export` | 导出客户 |
|
||||
| GET | `/work/client/{id}` | 客户详情 |
|
||||
| POST | `/work/client` | 新增客户 |
|
||||
| PUT | `/work/client` | 更新客户 |
|
||||
| DELETE | `/work/client/{ids}` | 删除客户 |
|
||||
|
||||
### 员工模块 `/work/staff*`
|
||||
| 控制器 | 路径 | 说明 |
|
||||
|--------|------|------|
|
||||
| TpStaffController | `/work/staff` | 员工管理 |
|
||||
| TzUserController | `/mall/user` | 用户管理 |
|
||||
| TpStaffPayController | `/work/staffPay` | 员工薪资 |
|
||||
| TpIntegralDetailController | `/work/integralDetail` | 积分明细 |
|
||||
|
||||
### 微信模块 `/work/wechat*`
|
||||
| 控制器 | 路径 | 说明 |
|
||||
|--------|------|------|
|
||||
| TpWechatController | `/work/wechat` | 微信管理 |
|
||||
| TpWechatUserController | `/work/wechatUser` | 微信用户 |
|
||||
| TpWechatNumController | `/work/wechatNum` | 微信好友数 |
|
||||
|
||||
#### TpWechatController 详细接口
|
||||
| 方法 | 路径 | 说明 |
|
||||
|------|------|------|
|
||||
| GET | `/work/wechat/list` | 微信列表 |
|
||||
| GET | `/work/wechat/wechatSum` | 微信统计 |
|
||||
| POST | `/work/wechat/export` | 导出微信 |
|
||||
| GET | `/work/wechat/{id}` | 微信详情 |
|
||||
| POST | `/work/wechat` | 新增微信 |
|
||||
| PUT | `/work/wechat` | 更新微信 |
|
||||
| POST | `/work/wechat/editUser` | 更新用户 |
|
||||
| DELETE | `/work/wechat/{ids}` | 删除微信 |
|
||||
|
||||
### 财务模块 `/work/receipt*`
|
||||
| 控制器 | 路径 | 说明 |
|
||||
|--------|------|------|
|
||||
| TpReceiptController | `/work/receipt` | 收款管理 |
|
||||
| TpRemittanceController | `/work/remittance` | 汇款管理 |
|
||||
|
||||
#### TpReceiptController 详细接口
|
||||
| 方法 | 路径 | 说明 |
|
||||
|------|------|------|
|
||||
| GET | `/work/receipt/list` | 收款列表 |
|
||||
| GET | `/work/receipt/receiptSum` | 收款统计 |
|
||||
| POST | `/work/receipt/export` | 导出收款 |
|
||||
| GET | `/work/receipt/{id}` | 收款详情 |
|
||||
| POST | `/work/receipt` | 新增收款 |
|
||||
| POST | `/work/receipt/claim` | 认领汇款 |
|
||||
| POST | `/work/receipt/back` | 退回汇款 |
|
||||
| DELETE | `/work/receipt/{ids}` | 删除收款 |
|
||||
|
||||
### 统计数据 `/work/dept*`
|
||||
| 控制器 | 路径 | 说明 |
|
||||
|--------|------|------|
|
||||
| TpDeptReportController | `/work/deptReport` | 部门报表 |
|
||||
| TpDeptCostController | `/work/deptCost` | 部门成本 |
|
||||
| TpYearController | `/work/year` | 年度目标 |
|
||||
| TpMonthController | `/work/month` | 月度目标 |
|
||||
|
||||
### 资源模块
|
||||
| 控制器 | 路径 | 说明 |
|
||||
|--------|------|------|
|
||||
| TpProdController | `/work/prod` | 商品管理 |
|
||||
| TpWorksController | `/work/works` | 作品收藏 |
|
||||
| TpFollowController | `/work/follow` | 关注管理 |
|
||||
| TpPanoramaController | `/work/panorama` | 全景图 |
|
||||
| TpDesignQuotesController | `/work/designQuotes` | 设计报价 |
|
||||
| TpFieldController | `/work/field` | 领域管理 |
|
||||
| TpChangePriceController | `/work/changePrice` | 改价配置 |
|
||||
| TzSharedAccountController | `/work/sharedAccount` | 共享账号 |
|
||||
|
||||
#### TpPanoramaController 详细接口
|
||||
| 方法 | 路径 | 说明 |
|
||||
|------|------|------|
|
||||
| GET | `/work/panorama/list` | 全景图列表 |
|
||||
| GET | `/work/panorama/listByOrderId` | 根据订单ID查询全景图 |
|
||||
| POST | `/work/panorama/export` | 导出全景图 |
|
||||
| GET | `/work/panorama/{id}` | 全景图详情 |
|
||||
| POST | `/work/panorama` | 新增全景图 |
|
||||
| PUT | `/work/panorama` | 更新全景图 |
|
||||
| DELETE | `/work/panorama/{ids}` | 删除全景图 |
|
||||
|
||||
---
|
||||
|
||||
## 三、通用CRUD接口格式
|
||||
|
||||
```
|
||||
GET /{path}/list # 列表查询
|
||||
POST /{path}/export # 导出数据
|
||||
GET /{path}/{id} # 详情查询
|
||||
POST /{path} # 新增
|
||||
PUT /{path} # 更新
|
||||
DELETE /{path}/{ids} # 删除
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 四、接口统计
|
||||
|
||||
- **ruoyi-admin**: 5 个控制器 (HomeController, IndexController, LoginController, AuthController, CaptchaController)
|
||||
- **ruoyi-work**: 34 个控制器
|
||||
- **总计**: 39 个控制器
|
||||
|
||||
---
|
||||
|
||||
## 五、订单状态流转
|
||||
|
||||
```
|
||||
客户下单 → 客服派单 → 技术接单 → 设计制作 → 完成交付 → 客户评价
|
||||
↓
|
||||
申请退款 (可选)
|
||||
```
|
||||
|
||||
## 六、用户身份
|
||||
|
||||
| identity | 说明 |
|
||||
|----------|------|
|
||||
| 1 | 管理员 |
|
||||
| 2 | 表现师/技术 |
|
||||
| 3 | 客服 |
|
||||
Reference in New Issue
Block a user