12 lines
343 B
Markdown
12 lines
343 B
Markdown
|
|
# API 文档
|
|||
|
|
|
|||
|
|
## 目录用途
|
|||
|
|
存放项目的 API 相关文档,包括接口定义、请求响应示例、错误码等。
|
|||
|
|
|
|||
|
|
## 文档规范
|
|||
|
|
- 文档命名格式:YYYY-MM-DD-00X-api.md
|
|||
|
|
- 必须包含接口列表、请求参数、响应参数、示例
|
|||
|
|
- 支持交叉引用其他文档
|
|||
|
|
|
|||
|
|
## 返回主索引
|
|||
|
|
[返回项目单一真源](../index.md)
|