58 lines
739 B
Markdown
58 lines
739 B
Markdown
|
# API接口文档
|
|||
|
|
|
|||
|
|
## 版本信息
|
|||
|
|
|
|||
|
|
- 版本: v1.0.0
|
|||
|
|
- 最后更新: 2025-01-XX
|
|||
|
|
- 维护者: 开发团队
|
|||
|
|
|
|||
|
|
## API基础信息
|
|||
|
|
|
|||
|
|
- 基础URL: `http://localhost:5000/api/v1`
|
|||
|
|
- 认证方式: Bearer Token（如需要）
|
|||
|
|
- 数据格式: JSON
|
|||
|
|
|
|||
|
|
## 接口列表
|
|||
|
|
|
|||
|
|
### 健康检查
|
|||
|
|
|
|||
|
|
**GET** `/health`
|
|||
|
|
|
|||
|
|
检查服务健康状态
|
|||
|
|
|
|||
|
|
**响应示例:**
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"status": "healthy"
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 首页
|
|||
|
|
|
|||
|
|
**GET** `/`
|
|||
|
|
|
|||
|
|
获取首页信息
|
|||
|
|
|
|||
|
|
**响应示例:**
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"message": "Hello, World!",
|
|||
|
|
"status": "ok"
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 错误码说明
|
|||
|
|
|
|||
|
|
- `200` - 成功
|
|||
|
|
- `400` - 请求参数错误
|
|||
|
|
- `401` - 未授权
|
|||
|
|
- `404` - 资源不存在
|
|||
|
|
- `500` - 服务器内部错误
|
|||
|
|
|
|||
|
|
## 变更记录
|
|||
|
|
|
|||
|
|
### v1.0.0 (2025-01-XX)
|
|||
|
|
- 初始版本
|
|||
|
|
- 添加健康检查和首页接口
|
|||
|
|
|