Files
jiaoyu/docs/api.md
T
Zhang Jing Xuan 0841b1a103 智教助手平台:完整初始化
- 前端:Vue3 + TS + Element Plus,24 个页面路由(课件/组题/教案/动画/思维导图/作文批改/命题/课堂/资源/社区等)
- 后端:FastAPI + SQLAlchemy + SQLite,17 个路由模块,AI 服务层含降级模板
- AI:glm-5.x 推理模型已禁用思维链,确保输出真实内容
- 修复:ai_service 两处请求体注入 enable_thinking/thinking disabled
- 测试账号:13900999999 / test1234
2026-07-29 16:29:10 +08:00

110 lines
2.8 KiB
Markdown

# API 接口文档
Base URL: `http://localhost:8000`
## 认证模块
| 方法 | 路径 | 说明 |
|------|------|------|
| POST | /api/auth/register | 教师注册 |
| POST | /api/auth/login | 教师登录 |
| GET | /api/auth/me | 获取个人信息 |
| PUT | /api/auth/me | 更新个人信息 |
## 课件模块
| 方法 | 路径 | 说明 |
|------|------|------|
| POST | /api/coursewares/ | 创建课件 |
| GET | /api/coursewares/ | 课件列表(支持筛选) |
| GET | /api/coursewares/{id} | 课件详情 |
| PUT | /api/coursewares/{id} | 更新课件 |
| DELETE | /api/coursewares/{id} | 删除课件 |
| POST | /api/coursewares/ai-generate | AI生成课件 |
## 教学动画模块
| 方法 | 路径 | 说明 |
|------|------|------|
| POST | /api/animations/ | 创建动画 |
| GET | /api/animations/ | 动画列表 |
| GET | /api/animations/{id} | 动画详情 |
| PUT | /api/animations/{id} | 更新动画 |
| DELETE | /api/animations/{id} | 删除动画 |
| POST | /api/animations/ai-generate | AI生成动画 |
## 互动练习模块
| 方法 | 路径 | 说明 |
|------|------|------|
| POST | /api/exercises/ | 创建练习 |
| GET | /api/exercises/ | 练习列表 |
| GET | /api/exercises/{id} | 练习详情 |
| DELETE | /api/exercises/{id} | 删除练习 |
| POST | /api/exercises/ai-generate | AI生成练习 |
| POST | /api/exercises/{id}/attempt | 提交答题 |
## 教案模块
| 方法 | 路径 | 说明 |
|------|------|------|
| POST | /api/lesson-plans/ | 创建教案 |
| GET | /api/lesson-plans/ | 教案列表 |
| GET | /api/lesson-plans/{id} | 教案详情 |
| DELETE | /api/lesson-plans/{id} | 删除教案 |
| POST | /api/lesson-plans/ai-generate | AI生成教案 |
## AI能力模块
| 方法 | 路径 | 说明 |
|------|------|------|
| POST | /api/ai/essay-grade | 作文批改 |
| POST | /api/ai/exam-generate | AI命题 |
## 资源库模块
| 方法 | 路径 | 说明 |
|------|------|------|
| POST | /api/resources/ | 上传资源 |
| GET | /api/resources/ | 资源列表 |
| GET | /api/resources/{id} | 资源详情 |
| POST | /api/resources/{id}/like | 点赞 |
| DELETE | /api/resources/{id} | 删除资源 |
## 教师社区模块
| 方法 | 路径 | 说明 |
|------|------|------|
| POST | /api/community/posts | 发布帖子 |
| GET | /api/community/posts | 帖子列表 |
| GET | /api/community/posts/{id} | 帖子详情 |
| POST | /api/community/posts/{id}/like | 点赞帖子 |
| DELETE | /api/community/posts/{id} | 删除帖子 |
| GET | /api/community/posts/{id}/comments | 评论列表 |
| POST | /api/community/posts/{id}/comments | 发表评论 |
## 认证方式
所有需要认证的接口请在请求头中携带 JWT Token:
```
Authorization: Bearer <access_token>
```
## 通用响应格式
成功响应:
```json
{
"success": true,
"data": { ... }
}
```
错误响应:
```json
{
"detail": "错误信息描述"
}
```