Table of Contents
2.7 接口字段阅读方式【已整理】
为方便 APP 联调，根目录 用户端接口文档.md 是 APP 用户端接口源文档，后续提到“接口文档”默认指本文档；接口字段必须以实际代码请求和返回为准，并同步写清完整请求示例、完整响应示例、字段说明和关键业务规则。
后续新增接口或调整字段时必须同步补充：
| 内容 | 必须补充位置 | 要求 |
|---|---|---|
| 请求字段 | 实际请求校验与读取逻辑 | 写清字段中文含义、类型、是否可空、枚举值、示例 |
| 响应字段 | 服务层或控制器实际返回结构 | 写清字段中文含义；状态、类型、开关字段必须标明每个值的含义 |
| 业务状态 | 当前接口说明或第 3 节 SQL 枚举 | 状态字段不能只写 status，必须说明 1/2/3 分别代表什么 |
| 示例 | 本文档对应接口示例 | 请求示例和响应示例必须完整，字段名和值结构必须与真实接口一致 |