# API 契约覆盖情况

此页随 `python3 scripts/generate-api-openapi.py` 从当前接口目录自动生成，用于给前后端同事判断文档可用程度。

- 方法、路径、中文用途、身份及模块业务规则：已覆盖当前目录中的全部操作。
- “泛型 JSON 响应”表示仍未列出该操作的具体响应字段，不能直接用于严格前端类型生成。
- “请求体无字段”表示已有业务文字说明，但 OpenAPI 尚未列出 JSON body 属性。
- 图片、CSV 等非 JSON 响应不计入泛型 JSON 响应。未接入的真实第三方能力不因文档存在而视为可用。

| 模块 | 操作数 | 泛型 JSON 响应 | 请求体无字段 |
| --- | ---: | ---: | ---: |
| 住户与房屋 | 15 | 2 | 0 |
| 保洁 | 23 | 21 | 12 |
| 公共接口 | 2 | 0 | 0 |
| 助浴 | 32 | 19 | 6 |
| 助餐与结算 | 46 | 46 | 1 |
| 员工工作台 | 2 | 0 | 0 |
| 居民通用服务 | 11 | 5 | 0 |
| 数据大屏 | 2 | 0 | 0 |
| 物业收费 | 18 | 18 | 0 |
| 社区公告与活动 | 15 | 15 | 0 |
| 社区商店 | 6 | 6 | 3 |
| 维修 | 30 | 18 | 3 |
| 账号与授权 | 14 | 5 | 0 |
| 身份与会话 | 11 | 3 | 0 |
| 门禁 | 8 | 6 | 0 |
| 陪诊 | 10 | 10 | 2 |
| **合计** | **245** | **174** | **27** |

优先从前端接入的登录、住户、账单、维修等链路补全响应 DTO；每项以服务端实现和隔离测试核对，再重新生成并发布。