api-template.md 820 B
doc_id: API-YYYYMM-NNN feature_id: FEAT-YYYYMM-NNN-short-name type: api title: 接口说明标题 status: draft owner: 负责人 created_at: YYYY-MM-DD updated_at: YYYY-MM-DD reviewers: [] related_docs:
- PRD-YYYYMM-NNN
- DES-YYYYMM-NNN related_modules: [] tags: [] ---
接口说明标题
契约位置
- OpenAPI:
docs/api/openapi/<name>.openapi.yaml
接口列表
| 方法 | 路径 | 说明 | 状态 |
|---|---|---|---|
POST |
/api/example |
示例接口 | draft |
鉴权
说明认证方式、权限要求和调用方身份。
请求和响应
以 OpenAPI 为准。本文只记录联调说明、特殊约定和示例。
错误码
| 错误码 | 含义 | 处理建议 |
|---|---|---|
联调记录
| 日期 | 参与方 | 结论 |
|---|---|---|
| YYYY-MM-DD |