接口设计规范
# 接口设计规范
| 业务场景 | 请求方式 | 传参方式 | 控制器方法名 | 接口路径示例 |
|---|---|---|---|---|
| 查询字典 | GET | 无 | dict | /api/order/dict |
| 订单分页查询 | POST | JSON | page | /api/order/page |
| 订单查询不分页 | POST | JSON | list | /api/order/list |
| 订单详情 | GET | PATH | detail | /api/order/detail/{id} |
| 订单创建 | POST | JSON | create | /api/order/create |
| 订单取消 | DELETE | JSON | cancel | /api/order/cancel |
| 订单批量取消 | POST | JSON | batchCancel | /api/order/batchCancel |
| 订单修改 | PUT | JSON | update | /api/order/update |
| 订单添加商品 | POST | JSON | itemAdd | /orders/{orderId}/items |
| 订单导出 | POST | JSON | export | /api/order/export |
| 订单支付 | POST | JSON | pay | /api/order/pay |
| 订单退款 | POST | JSON | refund | /api/order/refund |
| 订单发货 | POST | JSON | deliver | /api/order/deliver |
| 客户订单查询 | POST | JSON | countByMonth | /api/customer-order/countByMonth |
| 客户添加标签 | POST | JSON | addTag | /api/customer-tag/add |
| 客户账户充值 | POST | JSON | recharge | /api/customer-account/recharge |
- 业务动作类接口 针对 “非 CRUD 但有明确业务行为” 的操作(如订单支付、商品上架),用资源+动词命名
- /api/order/pay
- /api/order/refund
- 资源关联类接口 针对 “多资源关联操作”(如给用户分配角order-item/add
- 关联解除(如用户取消关联标签):DE色、订单添加商品),用资源1 + 连字符 + 资源2 + 动作命名
- 关联创建(如订单添加商品):POST /LETE /user-tag/remove
- 客户添加标签: POST /api/customer-tag/add
Last Updated: 2025/12/02, 11:22:00