21 lines
420 B
Markdown
21 lines
420 B
Markdown
|
# API文档中心
|
||
|
|
|
||
|
|
## 文档结构
|
||
|
|
- `endpoints.md` - API端点说明
|
||
|
|
- `models.md` - 数据模型说明
|
||
|
|
- `examples/` - API调用示例
|
||
|
|
|
||
|
|
## 编写规范
|
||
|
|
1. 每个API文档必须包含:
|
||
|
|
- 接口URL和方法
|
||
|
|
- 请求参数说明
|
||
|
|
- 响应数据结构
|
||
|
|
- 错误代码说明
|
||
|
|
- 调用示例
|
||
|
|
|
||
|
|
2. 变更记录:
|
||
|
|
- 2025/8/17 - 创建文档结构 (责任人: 开发团队)
|
||
|
|
|
||
|
|
版本: v1.0.0
|
||
|
|
最后更新: 2025/8/17
|