main:删除多余文档并清理项目目录
变更内容: - 移除冗余文档,包括 Grafana 指南、指标对比、修复总结、OpenAPI 规范等。 - 精简项目文档结构,优化 README 文件内容。 - 提升文档层次清晰度,集中核心指南。
This commit is contained in:
34
README.md
34
README.md
@@ -7,6 +7,7 @@
|
||||
## 特性
|
||||
|
||||
- ✅ **标准化 API 接口** - 符合 RESTful 规范的 HTTP 接口
|
||||
- ✅ **同步/异步调用** - 支持同步调用和异步任务
|
||||
- ✅ **开箱即用** - 完整的项目结构和配置
|
||||
- ✅ **自动文档** - Swagger/OpenAPI 自动生成
|
||||
- ✅ **监控指标** - Prometheus 指标和 Grafana 仪表板
|
||||
@@ -16,6 +17,16 @@
|
||||
- ✅ **完整测试** - 单元测试和集成测试
|
||||
- ✅ **CI/CD** - GitHub Actions 工作流
|
||||
|
||||
## 文档
|
||||
|
||||
| 文档 | 描述 |
|
||||
|------|------|
|
||||
| [快速入门](docs/getting-started.md) | 10 分钟上手指南 |
|
||||
| [算法开发指南](docs/algorithm-development.md) | 详细的算法开发教程 |
|
||||
| [API 参考](docs/api-reference.md) | 完整的 API 文档 |
|
||||
| [监控指南](docs/monitoring.md) | 监控和告警配置 |
|
||||
| [API 规范](docs/api/README.md) | OpenAPI 规范说明 |
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 前置要求
|
||||
@@ -76,7 +87,8 @@ docker-compose up
|
||||
### 核心接口
|
||||
|
||||
- `POST /invoke` - 同步调用算法
|
||||
- `POST /jobs` - 异步任务接口(预留)
|
||||
- `POST /jobs` - 创建异步任务
|
||||
- `GET /jobs/{job_id}` - 查询任务状态
|
||||
|
||||
### 健康检查
|
||||
|
||||
@@ -89,7 +101,7 @@ docker-compose up
|
||||
|
||||
## 示例请求
|
||||
|
||||
### 质数判断
|
||||
### 同步调用 - 质数判断
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:8000/invoke \
|
||||
@@ -117,6 +129,18 @@ curl -X POST http://localhost:8000/invoke \
|
||||
}
|
||||
```
|
||||
|
||||
### 异步任务
|
||||
|
||||
```bash
|
||||
# 创建任务
|
||||
curl -X POST http://localhost:8000/jobs \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"algorithm": "PrimeChecker", "params": {"number": 17}}'
|
||||
|
||||
# 查询状态
|
||||
curl http://localhost:8000/jobs/{job_id}
|
||||
```
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
@@ -141,6 +165,8 @@ FunctionalScaffold/
|
||||
|
||||
## 开发指南
|
||||
|
||||
详细的开发指南请参考 [算法开发指南](docs/algorithm-development.md)。
|
||||
|
||||
### 添加新算法
|
||||
|
||||
1. 在 `src/functional_scaffold/algorithms/` 创建新算法文件
|
||||
@@ -212,6 +238,8 @@ sam deploy --template-file deployment/serverless/aws-lambda.yaml
|
||||
|
||||
## 监控
|
||||
|
||||
详细的监控配置请参考 [监控指南](docs/monitoring.md)。
|
||||
|
||||
### Prometheus 指标
|
||||
|
||||
访问 `/metrics` 端点查看可用指标:
|
||||
@@ -220,6 +248,8 @@ sam deploy --template-file deployment/serverless/aws-lambda.yaml
|
||||
- `http_request_duration_seconds` - HTTP 请求延迟
|
||||
- `algorithm_executions_total` - 算法执行总数
|
||||
- `algorithm_execution_duration_seconds` - 算法执行延迟
|
||||
- `jobs_created_total` - 异步任务创建总数
|
||||
- `jobs_completed_total` - 异步任务完成总数
|
||||
|
||||
### Grafana 仪表板
|
||||
|
||||
|
||||
Reference in New Issue
Block a user