Roog (顾新培)
5feb795d12
变更内容： - 移除冗余文档，包括 Grafana 指南、指标对比、修复总结、OpenAPI 规范等。 - 精简项目文档结构，优化 README 文件内容。 - 提升文档层次清晰度，集中核心指南。
59 lines
1.2 KiB
Markdown
59 lines
1.2 KiB
Markdown
# API 文档
|
|
|
|
本目录包含 API 相关文档和自动生成的 OpenAPI 规范。
|
|
|
|
## 文件说明
|
|
|
|
- `openapi.json` - 自动生成的 OpenAPI 3.0 规范文件
|
|
|
|
## 生成文档
|
|
|
|
运行以下命令更新 OpenAPI 规范：
|
|
|
|
```bash
|
|
python scripts/export_openapi.py
|
|
```
|
|
|
|
## 在线文档
|
|
|
|
启动应用后，访问以下 URL 查看交互式文档：
|
|
|
|
| 文档类型 | 地址 |
|
|
|---------|------|
|
|
| Swagger UI | http://localhost:8000/docs |
|
|
| ReDoc | http://localhost:8000/redoc |
|
|
| OpenAPI JSON | http://localhost:8000/openapi.json |
|
|
|
|
## API 端点
|
|
|
|
### 核心接口
|
|
|
|
| 方法 | 端点 | 描述 |
|
|
|------|------|------|
|
|
| POST | `/invoke` | 同步调用算法 |
|
|
| POST | `/jobs` | 创建异步任务 |
|
|
| GET | `/jobs/{job_id}` | 查询任务状态 |
|
|
|
|
### 健康检查
|
|
|
|
| 方法 | 端点 | 描述 |
|
|
|------|------|------|
|
|
| GET | `/healthz` | 存活检查 |
|
|
| GET | `/readyz` | 就绪检查 |
|
|
|
|
### 监控
|
|
|
|
| 方法 | 端点 | 描述 |
|
|
|------|------|------|
|
|
| GET | `/metrics` | Prometheus 指标 |
|
|
|
|
## 详细文档
|
|
|
|
完整的 API 参考文档请查看：[API 参考文档](../api-reference.md)
|
|
|
|
## 注意事项
|
|
|
|
- `openapi.json` 是自动生成的，请勿手动编辑
|
|
- API 变更后需要重新运行导出脚本
|
|
- 确保 Pydantic 模型包含完整的文档字符串和示例
|