191 lines
2.2 KiB
Markdown
191 lines
2.2 KiB
Markdown
# API 文档
|
|
|
|
## 基础 URL
|
|
`http://localhost:3000/api`
|
|
|
|
---
|
|
|
|
## 车辆管理 (Vehicles)
|
|
|
|
### 获取所有车辆
|
|
```
|
|
GET /vehicles
|
|
```
|
|
|
|
### 获取单个车辆
|
|
```
|
|
GET /vehicles/:id
|
|
```
|
|
|
|
### 创建车辆
|
|
```
|
|
POST /vehicles
|
|
```
|
|
请求体:
|
|
```json
|
|
{
|
|
"vehicleId": "SCOOTER001",
|
|
"model": "黑骑士",
|
|
"brand": "小牛",
|
|
"color": "黑色",
|
|
"batteryType": "锂电池",
|
|
"batteryCapacity": 20,
|
|
"status": "空闲"
|
|
}
|
|
```
|
|
|
|
### 更新车辆
|
|
```
|
|
PUT /vehicles/:id
|
|
```
|
|
|
|
### 删除车辆
|
|
```
|
|
DELETE /vehicles/:id
|
|
```
|
|
|
|
### 按状态筛选车辆
|
|
```
|
|
GET /vehicles/status/:status
|
|
```
|
|
状态: 空闲, 在租, 维修中, 已报废, 待回收
|
|
|
|
### 更新车辆位置
|
|
```
|
|
PATCH /vehicles/:id/location
|
|
```
|
|
请求体:
|
|
```json
|
|
{
|
|
"longitude": 116.397,
|
|
"latitude": 39.909
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## 订单管理 (Orders)
|
|
|
|
### 获取所有订单
|
|
```
|
|
GET /orders
|
|
```
|
|
|
|
### 获取单个订单
|
|
```
|
|
GET /orders/:id
|
|
```
|
|
|
|
### 创建订单
|
|
```
|
|
POST /orders
|
|
```
|
|
请求体:
|
|
```json
|
|
{
|
|
"customer": "客户ID",
|
|
"vehicle": "车辆ID",
|
|
"startDate": "2026-03-05",
|
|
"endDate": "2026-03-12",
|
|
"rentalFee": 50,
|
|
"deposit": 200
|
|
}
|
|
```
|
|
|
|
### 结束订单
|
|
```
|
|
PATCH /orders/:id/complete
|
|
```
|
|
|
|
### 获取逾期订单
|
|
```
|
|
GET /orders/status/overdue
|
|
```
|
|
|
|
### 按状态筛选订单
|
|
```
|
|
GET /orders/status/:status
|
|
```
|
|
状态: 待支付, 进行中, 已完成, 逾期, 已取消, 已退款
|
|
|
|
---
|
|
|
|
## 客户管理 (Customers)
|
|
|
|
### 获取所有客户
|
|
```
|
|
GET /customers
|
|
```
|
|
|
|
### 获取单个客户
|
|
```
|
|
GET /customers/:id
|
|
```
|
|
|
|
### 创建客户
|
|
```
|
|
POST /customers
|
|
```
|
|
请求体:
|
|
```json
|
|
{
|
|
"name": "张三",
|
|
"phone": "13800138000",
|
|
"idCard": "110101199001011234"
|
|
}
|
|
```
|
|
|
|
### 更新客户
|
|
```
|
|
PUT /customers/:id
|
|
```
|
|
|
|
### 删除客户
|
|
```
|
|
DELETE /customers/:id
|
|
```
|
|
|
|
### 搜索客户
|
|
```
|
|
GET /customers/search/:keyword
|
|
```
|
|
|
|
### 更新客户信用评分
|
|
```
|
|
PATCH /customers/:id/credit
|
|
```
|
|
请求体:
|
|
```json
|
|
{
|
|
"creditScore": 85
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## 财务管理 (Finance)
|
|
|
|
### 获取财务统计
|
|
```
|
|
GET /finance/stats
|
|
```
|
|
|
|
### 获取收入趋势
|
|
```
|
|
GET /finance/trend?period=month
|
|
```
|
|
参数: week, month, quarter, year
|
|
|
|
### 获取逾期账款列表
|
|
```
|
|
GET /finance/overdue
|
|
```
|
|
|
|
---
|
|
|
|
## 健康检查
|
|
```
|
|
GET /health
|
|
```
|
|
返回: `{ "status": "ok", "timestamp": "..." }`
|