项目初始化
This commit is contained in:
32
09-后台API说明/字段级接口清单模板.md
Normal file
32
09-后台API说明/字段级接口清单模板.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# 字段级接口清单模板
|
||||
|
||||
## 1. 使用方式
|
||||
后续每个接口都建议按以下格式补齐,补完后即可直接交给 agent 编写 Controller、DTO、Service 和测试。
|
||||
|
||||
## 2. 模板
|
||||
### 接口名称
|
||||
- 接口路径:
|
||||
- 请求方法:
|
||||
- 使用端:用户端 / 商户端 / 管理端
|
||||
- 功能说明:
|
||||
- 权限要求:
|
||||
|
||||
### 请求参数
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
| --- | --- | --- | --- |
|
||||
| | | | |
|
||||
|
||||
### 返回字段
|
||||
| 字段 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| | | |
|
||||
|
||||
### 错误码
|
||||
| code | 场景 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| | | |
|
||||
|
||||
### 备注
|
||||
- 幂等要求:
|
||||
- 状态变更:
|
||||
- 日志要求:
|
||||
Reference in New Issue
Block a user