289 lines
7.2 KiB
Markdown
289 lines
7.2 KiB
Markdown
# 订单系统 - 文档索引
|
|
|
|
## 📚 文档导航
|
|
|
|
### 🚀 快速开始
|
|
- **[README_ORDER.md](./README_ORDER.md)** - 快速开始指南
|
|
- 系统概述
|
|
- 快速安装
|
|
- 基本使用
|
|
|
|
### 📖 完整文档
|
|
- **[ORDER_SYSTEM_COMPLETE.md](./ORDER_SYSTEM_COMPLETE.md)** - 完整系统文档
|
|
- 系统架构
|
|
- 核心功能
|
|
- 数据库设计
|
|
- API端点
|
|
- 前端功能
|
|
- 安装步骤
|
|
|
|
### ⚡ 快速参考
|
|
- **[ORDER_QUICK_REFERENCE.md](./ORDER_QUICK_REFERENCE.md)** - 快速参考手册
|
|
- 功能速查表
|
|
- API速查
|
|
- 常见问题
|
|
- 文件位置
|
|
- 权限配置
|
|
|
|
### 🔍 API文档
|
|
- **[PATIENT_SEARCH_API.md](./PATIENT_SEARCH_API.md)** - 患者搜索API文档
|
|
- 搜索接口说明
|
|
- 参数定义
|
|
- 返回格式
|
|
- 使用示例
|
|
|
|
### ✅ 安装指南
|
|
- **[INSTALLATION_CHECKLIST.md](./INSTALLATION_CHECKLIST.md)** - 安装检查清单
|
|
- 前置条件
|
|
- 安装步骤
|
|
- 配置说明
|
|
- 验证方法
|
|
|
|
### 🧪 验证清单
|
|
- **[ORDER_VERIFICATION_CHECKLIST.md](./ORDER_VERIFICATION_CHECKLIST.md)** - 验证清单
|
|
- 系统完成度检查
|
|
- 功能验证
|
|
- 部署检查
|
|
- 性能检查
|
|
- 安全检查
|
|
|
|
### 📊 项目总结
|
|
- **[../TASK_COMPLETION_SUMMARY.md](../TASK_COMPLETION_SUMMARY.md)** - 任务完成总结
|
|
- 项目概览
|
|
- 完成的任务
|
|
- 创建的文件
|
|
- 核心功能
|
|
- 系统架构
|
|
|
|
---
|
|
|
|
## 📁 文件结构
|
|
|
|
### 后端文件
|
|
```
|
|
server/
|
|
├── app/
|
|
│ ├── common/
|
|
│ │ └── model/
|
|
│ │ ├── Order.php # 订单模型
|
|
│ │ └── OrderDetail.php # 订单详情模型
|
|
│ └── adminapi/
|
|
│ ├── controller/order/
|
|
│ │ └── OrderController.php # 订单控制器
|
|
│ ├── logic/order/
|
|
│ │ └── OrderLogic.php # 订单业务逻辑
|
|
│ ├── validate/order/
|
|
│ │ └── OrderValidate.php # 订单验证
|
|
│ └── lists/order/
|
|
│ └── OrderLists.php # 订单列表
|
|
└── database/
|
|
└── migrations/
|
|
└── 2024_03_10_create_order_tables.php # 数据库迁移
|
|
```
|
|
|
|
### 前端文件
|
|
```
|
|
admin/
|
|
├── src/
|
|
│ ├── views/order/
|
|
│ │ └── index.vue # 订单列表页面
|
|
│ └── api/
|
|
│ └── order.ts # 订单API接口
|
|
└── order.sql # 数据库脚本
|
|
```
|
|
|
|
### 文档文件
|
|
```
|
|
admin/
|
|
├── README_ORDER.md # 快速开始
|
|
├── PATIENT_SEARCH_API.md # 患者搜索API
|
|
├── INSTALLATION_CHECKLIST.md # 安装指南
|
|
├── ORDER_SYSTEM_COMPLETE.md # 完整文档
|
|
├── ORDER_QUICK_REFERENCE.md # 快速参考
|
|
├── ORDER_VERIFICATION_CHECKLIST.md # 验证清单
|
|
└── ORDER_DOCUMENTATION_INDEX.md # 文档索引（本文件）
|
|
```
|
|
|
|
---
|
|
|
|
## 🎯 按用途查找文档
|
|
|
|
### 我想快速了解系统
|
|
👉 **[README_ORDER.md](./README_ORDER.md)**
|
|
|
|
### 我想查看完整的系统设计
|
|
👉 **[ORDER_SYSTEM_COMPLETE.md](./ORDER_SYSTEM_COMPLETE.md)**
|
|
|
|
### 我想快速查找某个功能或API
|
|
👉 **[ORDER_QUICK_REFERENCE.md](./ORDER_QUICK_REFERENCE.md)**
|
|
|
|
### 我想了解患者搜索功能
|
|
👉 **[PATIENT_SEARCH_API.md](./PATIENT_SEARCH_API.md)**
|
|
|
|
### 我想安装和部署系统
|
|
👉 **[INSTALLATION_CHECKLIST.md](./INSTALLATION_CHECKLIST.md)**
|
|
|
|
### 我想验证系统是否完整
|
|
👉 **[ORDER_VERIFICATION_CHECKLIST.md](./ORDER_VERIFICATION_CHECKLIST.md)**
|
|
|
|
### 我想了解项目完成情况
|
|
👉 **[../TASK_COMPLETION_SUMMARY.md](../TASK_COMPLETION_SUMMARY.md)**
|
|
|
|
---
|
|
|
|
## 🔑 关键概念
|
|
|
|
### 订单类型
|
|
| 类型 | 值 | 说明 |
|
|
|------|-----|------|
|
|
| 挂号费 | 1 | 医生挂号费用 |
|
|
| 问诊费 | 2 | 在线问诊费用 |
|
|
| 药品费用 | 3 | 药品购买费用 |
|
|
|
|
### 订单状态
|
|
| 状态 | 值 | 说明 |
|
|
|------|-----|------|
|
|
| 待支付 | 1 | 新创建的订单 |
|
|
| 已支付 | 2 | 已完成支付 |
|
|
| 已取消 | 3 | 已取消的订单 |
|
|
| 已退款 | 4 | 已退款的订单 |
|
|
|
|
### 支付方式
|
|
| 方式 | 值 | 说明 |
|
|
|------|-----|------|
|
|
| 支付宝 | alipay | 支付宝支付 |
|
|
| 微信 | wechat | 微信支付 |
|
|
| 银行卡 | bank | 银行卡支付 |
|
|
|
|
---
|
|
|
|
## 🔗 API端点速查
|
|
|
|
### 订单管理
|
|
- `GET /order.order/lists` - 订单列表
|
|
- `GET /order.order/detail` - 订单详情
|
|
- `POST /order.order/create` - 创建订单
|
|
- `POST /order.order/edit` - 编辑订单
|
|
- `POST /order.order/delete` - 删除订单
|
|
|
|
### 订单操作
|
|
- `POST /order.order/pay` - 支付订单
|
|
- `POST /order.order/cancel` - 取消订单
|
|
- `POST /order.order/refund` - 退款订单
|
|
|
|
### 其他
|
|
- `GET /order.order/export` - 导出订单
|
|
- `GET /tcm.diagnosis/searchPatient` - 搜索患者
|
|
|
|
---
|
|
|
|
## 📋 权限标识
|
|
|
|
```
|
|
order.order/lists # 订单列表
|
|
order.order/detail # 订单详情
|
|
order.order/create # 创建订单
|
|
order.order/edit # 编辑订单
|
|
order.order/pay # 支付订单
|
|
order.order/cancel # 取消订单
|
|
order.order/refund # 退款订单
|
|
order.order/delete # 删除订单
|
|
order.order/export # 导出订单
|
|
```
|
|
|
|
---
|
|
|
|
## 🛠️ 常用命令
|
|
|
|
### 创建数据库表
|
|
```bash
|
|
mysql -u root -p database_name < admin/order.sql
|
|
```
|
|
|
|
### 查看订单列表
|
|
```bash
|
|
curl "http://localhost/api/order.order/lists?page_no=1&page_size=15"
|
|
```
|
|
|
|
### 创建订单
|
|
```bash
|
|
curl -X POST "http://localhost/api/order.order/create" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"patient_id": 1,
|
|
"order_type": 1,
|
|
"amount": 100.00,
|
|
"details": []
|
|
}'
|
|
```
|
|
|
|
---
|
|
|
|
## ❓ 常见问题
|
|
|
|
### Q: 系统包含哪些功能？
|
|
A: 订单创建、查看、编辑、删除、支付、取消、退款、导出等完整功能。
|
|
|
|
### Q: 患者信息从哪里来？
|
|
A: 从诊单表（tcm_diagnosis）搜索患者。
|
|
|
|
### Q: 创建人ID是什么？
|
|
A: 自动记录当前登录管理员的ID，用于追踪订单创建者。
|
|
|
|
### Q: 如何安装系统？
|
|
A: 参考 [INSTALLATION_CHECKLIST.md](./INSTALLATION_CHECKLIST.md)
|
|
|
|
### Q: 如何验证系统是否完整？
|
|
A: 参考 [ORDER_VERIFICATION_CHECKLIST.md](./ORDER_VERIFICATION_CHECKLIST.md)
|
|
|
|
---
|
|
|
|
## 📞 获取帮助
|
|
|
|
1. **查看文档** - 首先查看相关文档
|
|
2. **查看示例** - 查看代码中的注释和示例
|
|
3. **查看日志** - 检查系统日志获取错误信息
|
|
4. **联系支持** - 联系开发团队
|
|
|
|
---
|
|
|
|
## 📈 文档更新历史
|
|
|
|
| 日期 | 版本 | 更新内容 |
|
|
|------|------|---------|
|
|
| 2026-03-10 | 1.0.0 | 初始版本，系统完成 |
|
|
|
|
---
|
|
|
|
## 🎓 学习路径
|
|
|
|
### 初级用户
|
|
1. 阅读 [README_ORDER.md](./README_ORDER.md)
|
|
2. 按照 [INSTALLATION_CHECKLIST.md](./INSTALLATION_CHECKLIST.md) 安装
|
|
3. 使用系统进行基本操作
|
|
|
|
### 中级用户
|
|
1. 阅读 [ORDER_SYSTEM_COMPLETE.md](./ORDER_SYSTEM_COMPLETE.md)
|
|
2. 查看 [ORDER_QUICK_REFERENCE.md](./ORDER_QUICK_REFERENCE.md)
|
|
3. 了解API和权限配置
|
|
|
|
### 高级用户
|
|
1. 查看源代码实现
|
|
2. 阅读 [ORDER_VERIFICATION_CHECKLIST.md](./ORDER_VERIFICATION_CHECKLIST.md)
|
|
3. 进行系统扩展和定制
|
|
|
|
---
|
|
|
|
## 📊 系统状态
|
|
|
|
- **版本**: 1.0.0
|
|
- **状态**: ✅ 生产就绪
|
|
- **完成度**: 100%
|
|
- **质量评分**: ⭐⭐⭐⭐⭐
|
|
|
|
---
|
|
|
|
**最后更新**: 2026-03-10
|
|
**维护者**: 开发团队
|
|
**许可证**: 项目许可证
|