https://github.com/wchiways/question-bank
基于 FastAPI + AsyncIO 的 OCS 题库查询系统，支持多个 AI 平台智能答题
https://github.com/wchiways/question-bank
ai asyncio fastapi intelligent-answer multiple-ai-providers ocs python question-bank quiz sqlmodel
Last synced: about 1 month ago
JSON representation
基于 FastAPI + AsyncIO 的 OCS 题库查询系统，支持多个 AI 平台智能答题
- Host: GitHub
- URL: https://github.com/wchiways/question-bank
- Owner: wchiways
- License: mit
- Created: 2025-12-27T06:38:56.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-01-02T08:32:16.000Z (about 2 months ago)
- Last Synced: 2026-01-13T22:59:46.439Z (about 1 month ago)
- Topics: ai, asyncio, fastapi, intelligent-answer, multiple-ai-providers, ocs, python, question-bank, quiz, sqlmodel
- Language: Python
- Homepage:
- Size: 444 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OCS题库系统 - FastAPI版本
[](https://www.python.org/downloads/)
[](https://fastapi.tiangolo.com)
[](./LICENSE)
[](https://github.com/psf/black)
> 基于 FastAPI + AsyncIO + SQLModel 的高性能题库查询系统
## ✨ 特性
- ✅ **异步架构**: 全链路异步处理，支持高并发
- ✅ **类型安全**: 100%类型注解，Pydantic数据验证
- ✅ **自动文档**: Swagger UI和ReDoc自动生成
- ✅ **分层设计**: 清晰的分层架构，易于维护
- ✅ **三级缓存**: 内存缓存 + 数据库 + AI服务
- ✅ **智能重试**: AI调用失败自动重试
- ✅ **多AI平台**: 支持硅基流动、阿里百炼、智谱AI、Google、OpenAI等多个平台
## 📖 文档导航
- [安装指南 (docs/INSTALL.md)](./docs/INSTALL.md) - 详细的安装和配置步骤
- [Docker 部署 (docs/DOCKER.md)](./docs/DOCKER.md) - 容器化部署指南
- [API 文档 (docs/API.md)](./docs/API.md) - 完整的 API 接口文档和使用示例
- [开发指南 (docs/DEVELOPMENT.md)](./docs/DEVELOPMENT.md) - 项目架构、开发流程和编码规范
## 👤 作者
**Chiway Wang**
- Email: [wchiway@163.com](mailto:wchiway@163.com)
- Blog: [chiway.blog](https://chiway.blog)
## 🛠️ 技术栈
- **Web框架**: FastAPI 0.127+
- **ORM**: SQLModel (Pydantic + SQLAlchemy)
- **数据库**: SQLite (aiosqlite异步驱动)
- **HTTP客户端**: httpx (异步)
- **日志**: loguru
- **包管理**: uv
## 📦 快速开始
### 环境要求
- Python 3.11+
- uv (推荐) 或 pip
### 安装
```bash
# 克隆项目
git clone https://github.com/wchiways/question-bank.git
cd ocs-tiku
# 使用uv (推荐)
uv sync
# 或使用pip
pip install -e .
```
### 配置
复制配置文件模板：
```bash
cp config.example.json config.json
```
编辑`config.json`文件，配置你的AI服务：
```json
{
"ai": {
"default_provider": "siliconflow",
"providers": {
"siliconflow": {
"enabled": true,
"api_key": "YOUR_API_KEY"
},
"ali_bailian": {
"enabled": false,
"api_key": "YOUR_ALI_BAILIAN_API_KEY"
}
}
}
}
```
**支持的AI平台**:
- **硅基流动** (siliconflow) - 默认，性价比高
- **阿里百炼** (ali_bailian) - 阿里云大模型平台
- **智谱AI** (zhipu) - 清华KEG实验室
- **Google Studio AI** (google) - Google Gemini
- **OpenAI** (openai) - GPT系列模型
### 运行
```bash
# 开发模式
uv run uvicorn app.main:app --reload --host 0.0.0.0 --port 8000
# 或使用脚本
./scripts/dev.sh
```
访问API文档：
- Swagger UI: http://localhost:8000/docs
- ReDoc: http://localhost:8000/redoc
- 健康检查: http://localhost:8000/health
### 部署方式 (Docker)
如果你偏好使用容器化部署，请参考：
👉 [Docker 部署指南 (docs/DOCKER.md)](./docs/DOCKER.md)
```bash
# 快速启动
docker compose up -d --build
```
## 📁 项目结构
```
ocs-tiku/
├── app/
│ ├── api/ # API路由层
│ │ ├── deps.py # 依赖注入
│ │ └── v1/ # API v1版本
│ ├── core/ # 核心配置
│ │ ├── config.py # 配置管理
│ │ ├── db.py # 数据库连接
│ │ └── logger.py # 日志系统
│ ├── models/ # 数据模型
│ ├── schemas/ # Pydantic Schema
│ ├── repositories/ # 数据访问层
│ ├── services/ # 业务逻辑层
│ └── providers/ # 外部服务提供商
├── tests/ # 测试
├── .env.example # 环境变量模板
├── pyproject.toml # 项目配置
└── README.md
```
## 🔌 API使用
### 查询问题答案
```bash
curl "http://localhost:8000/api/v1/query?title=中国的首都是哪里？&options=A.北京 B.上海&type=single"
```
响应：
```json
{
"code": 1,
"data": "A.北京",
"msg": "AI回答",
"source": "ai"
}
```
### 🧩 OCS网课助手配置
在油猴脚本或OCS软件中配置自定义题库：
```json
{
"name": "OCS题库(FastAPI版)",
"homepage": "https://chiway.blog/",
"url": "http://localhost:8000/api/v1/query",
"method": "get",
"type": "GM_xmlhttpRequest",
"contentType": "json",
"data": {
"title": "${title}",
"options": "${options}",
"type": "${type}"
},
"handler": "return (res)=>res.code === 0 ? [undefined, undefined] : [undefined, res.data]"
}
```
> **注意**: `handler` 中必须使用 `res.data` 而不是 `res.data.data`，因为FastAPI版本的响应结构更加扁平。
## 🧪 测试
```bash
# 运行测试
uv run pytest tests/ -v
# 查看覆盖率
uv run pytest tests/ --cov=app --cov-report=html
```
## 📊 性能
相比旧版Flask架构：
| 指标 | Flask版本 | FastAPI版本 | 提升 |
|------|----------|-------------|------|
| 并发处理 | 4 QPS | 200+ QPS | **50倍** |
| 响应时间 | ~100ms | <50ms | **2倍** |
| 代码量 | 239行 | 减少40% | 更简洁 |
## 🔄 从Flask迁移
旧版本（Flask）保留在Git历史中。新版本（FastAPI）在`development`分支开发。
迁移步骤：
1. 备份数据库：`cp question_bank.db question_bank.db.backup`
2. 安装新依赖：`uv sync`
3. 配置AI服务：复制`config.example.json`为`config.json`并填入API密钥
4. 启动新服务：`uv run uvicorn app.main:app`或`./scripts/dev.sh`
## 📝 开发指南
### 添加新的API端点
1. 在`app/schemas/`定义请求/响应模型
2. 在`app/api/v1/endpoints/`创建端点文件
3. 在`app/api/v1/router.py`注册路由
4. 添加相应的服务和仓储方法
### 代码风格
```bash
# 格式化代码
uv run black app/
# 代码检查
uv run ruff check app/
```
## 🤝 贡献
欢迎提交 Issue 和 Pull Request！
1. Fork 本仓库
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'feat: add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 开启 Pull Request
## 📄 许可证
本项目采用 MIT 许可证 - 详见 [LICENSE](./LICENSE) 文件
## 🔗 相关链接
- [FastAPI 文档](https://fastapi.tiangolo.com/)
- [SQLModel 文档](https://sqlmodel.tiangolo.com/)
- [uv 包管理器](https://github.com/astral-sh/uv)
## 🌟 Star History
如果这个项目对你有帮助，请给它一个 Star！
## 🎉 致谢
- [FastAPI](https://fastapi.tiangolo.com/)
- [SQLModel](https://sqlmodel.tiangolo.com/)
- [uv](https://github.com/astral-sh/uv)
- 原项目：[ai-ocs-question_bank](https://github.com/Miaozeqiu/ai-ocs-question_bank) by Miaozeqiu