700 lines
12 KiB
Markdown
700 lines
12 KiB
Markdown
# 词典服务器 API 接口文档
|
||
|
||
## 项目概述
|
||
|
||
本项目是一个多语言词典API服务，支持法语和日语词典的查询和管理功能。基于FastAPI框架开发，提供用户认证、词典搜索、后台管理等功能。
|
||
|
||
**服务器地址**: `http://127.0.0.1:8000`
|
||
**技术栈**: FastAPI, Tortoise ORM, MySQL, Redis, JWT
|
||
|
||
---
|
||
|
||
## 认证说明
|
||
|
||
大部分API需要JWT令牌认证。在请求头中包含：
|
||
|
||
```http
|
||
Authorization: Bearer <your_jwt_token>
|
||
```
|
||
|
||
---
|
||
|
||
## API 接口分类
|
||
|
||
### 1. 用户认证模块 (`/users`)
|
||
|
||
#### 1.1 用户注册
|
||
##### 1.1.1 注册主接口
|
||
|
||
- **接口**: `POST /users/register`
|
||
- **描述**: 新用户注册
|
||
- **请求体**:
|
||
|
||
```json
|
||
{
|
||
"username": "string",
|
||
"password": "string",
|
||
"email": "EmailFields[string]",
|
||
"phone": "PhoneFields",
|
||
"lang_pref": "jp" | "fr" | "private",
|
||
"portrait": "string",
|
||
"code": "string"
|
||
}
|
||
```
|
||
|
||
- **响应**:
|
||
|
||
```json
|
||
{
|
||
"id": "integer",
|
||
"message": "register success"
|
||
}
|
||
```
|
||
|
||
- **状态码**:
|
||
- `200`: 注册成功
|
||
- `400`: 参数验证失败
|
||
|
||
##### 1.1.2 邮箱验证
|
||
|
||
- **接口**: `POST /users/register/email_verify`
|
||
- **描述**: 新用户注册时的邮箱验证
|
||
- **请求体**:
|
||
|
||
```json
|
||
{
|
||
"user_email" : "string"
|
||
}
|
||
```
|
||
|
||
- **响应**:
|
||
|
||
```json
|
||
{
|
||
"message": "验证码已发送"
|
||
}
|
||
```
|
||
|
||
- **状态码**:
|
||
- `200`: 邮件发送成功
|
||
- `400`: 邮箱已被使用
|
||
|
||
#### 1.2 用户登录
|
||
|
||
- **接口**: `POST /users/login`
|
||
- **描述**: 用户登录获取访问令牌
|
||
- **请求体**:
|
||
|
||
```json
|
||
{
|
||
"name": "string",
|
||
"password": "string"
|
||
}
|
||
```
|
||
|
||
- **响应**:
|
||
|
||
```json
|
||
{
|
||
"access_token": "string",
|
||
"token_type": "bearer",
|
||
"user": {
|
||
"id": "integer",
|
||
"username": "string",
|
||
"is_admin": "boolean"
|
||
}
|
||
}
|
||
```
|
||
|
||
- **状态码**:
|
||
- `200`: 登录成功
|
||
- `400`: 用户名或密码错误
|
||
- `404`: 用户不存在
|
||
|
||
#### 1.3 用户登出
|
||
|
||
- **接口**: `POST /users/logout`
|
||
- **描述**: 用户登出，将令牌加入黑名单
|
||
- **需要认证**: 是
|
||
- **响应**:
|
||
|
||
```json
|
||
{
|
||
"message": "logout ok"
|
||
}
|
||
```
|
||
|
||
- **状态码**:
|
||
- `200`: 登出成功
|
||
- `401`: 未登录或令牌无效
|
||
|
||
#### 1.4 更新用户信息
|
||
|
||
- **接口**: `PUT /users/update`
|
||
- **描述**: 修改用户信息（用户名、密码等）
|
||
- **需要认证**: 是
|
||
- **请求体**:
|
||
|
||
```json
|
||
{
|
||
"current_password": "string",
|
||
"new_username": "string",
|
||
"new_password": "string",
|
||
"new_language": "jp" | "fr" | "private"
|
||
}
|
||
```
|
||
|
||
- **状态码**:
|
||
- `200`: 更新成功
|
||
- `400`: 原密码错误或用户名为保留词
|
||
|
||
#### 1.5 邮箱找回密码（发送验证码）
|
||
|
||
- **接口**: `POST /users/auth/forget-password/email`
|
||
- **描述**: 用户请求通过邮箱找回密码时，向注册邮箱发送验证码
|
||
- **请求体**:
|
||
|
||
```json
|
||
{
|
||
"email": "string"
|
||
}
|
||
```
|
||
|
||
|
||
- **响应**:
|
||
|
||
```json
|
||
{
|
||
"message": "验证码已发送"
|
||
}
|
||
```
|
||
|
||
|
||
- **状态码**
|
||
- `200`: 更新成功
|
||
- `404`: 用户不存在
|
||
|
||
#### 1.6 邮箱验证码验证
|
||
|
||
- **接口**: `POST /users/auth/varify_code/email`
|
||
- **描述**: 用户输入邮箱验证码后，验证验证码是否有效，返回重置令牌
|
||
- **请求体**:
|
||
```json
|
||
{
|
||
"email": "string",
|
||
"code": "string"
|
||
}
|
||
```
|
||
|
||
- **响应**
|
||
```json
|
||
{
|
||
"reset_token": "string"
|
||
}
|
||
```
|
||
|
||
- **状态码**
|
||
- `200`: 验证码验证成功
|
||
- `400`: 验证码错误或已过期
|
||
|
||
#### 1.7 重置密码
|
||
|
||
- **接口**: `POST /users/auth/reset-password`
|
||
- **描述**: 用户通过邮箱验证码获得的重置令牌来设置新密码
|
||
- **请求头**:
|
||
- `x-reset-token`: 重置令牌
|
||
- **请求体**:
|
||
```json
|
||
{
|
||
"password": "string"
|
||
}
|
||
```
|
||
|
||
- **响应**
|
||
```json
|
||
{
|
||
"massage": "密码重置成功"
|
||
}
|
||
```
|
||
|
||
- **状态码**
|
||
- `200`: 密码重置成功
|
||
- `400`: 密码不合法或令牌无效
|
||
|
||
---
|
||
|
||
### 2. 词典搜索模块
|
||
|
||
#### 2.1 词典搜索
|
||
|
||
- **接口**: `POST /search`
|
||
- **描述**: 根据关键词搜索词典内容
|
||
- **需要认证**: 是
|
||
- **请求体**:
|
||
|
||
```json
|
||
{
|
||
"query": "string",
|
||
"language": "fr" | "jp",
|
||
"sort": "relevance" | "date",
|
||
"order": "asc" | "des"
|
||
}
|
||
```
|
||
|
||
- **法语响应示例**:
|
||
|
||
```json
|
||
{
|
||
"query": "string",
|
||
"pos": ["n.m.", "v.t."],
|
||
"contents": [
|
||
{
|
||
"pos": "n.m.",
|
||
"chi_exp": "中文解释",
|
||
"eng_explanation": "English explanation",
|
||
"example": "例句"
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
- **日语响应示例**:
|
||
|
||
```json
|
||
{
|
||
"query": "string",
|
||
"pos": ["名词", "动词"],
|
||
"contents": [
|
||
{
|
||
"chi_exp": "中文解释",
|
||
"example": "例句"
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
- **状态码**:
|
||
- `200`: 搜索成功
|
||
- `404`: 未找到词条
|
||
- `401`: 未授权
|
||
|
||
#### 2.2 搜索建议
|
||
|
||
- **接口**: `POST /search/list`
|
||
- **描述**: 获取搜索自动完成建议
|
||
- **需要认证**: 是
|
||
- **请求体**:
|
||
|
||
```json
|
||
{
|
||
"query": "string",
|
||
"language": "fr" | "jp"
|
||
}
|
||
```
|
||
|
||
---
|
||
|
||
### 3. 翻译模块 (`/translate`)
|
||
|
||
#### 3.1 文本翻译
|
||
|
||
- **接口**: `POST /translate`
|
||
- **描述**: 使用百度翻译API进行文本翻译
|
||
- **需要认证**: 是
|
||
- **请求体**:
|
||
|
||
```json
|
||
{
|
||
"query": "Hello World",
|
||
"from_lang": "auto",
|
||
"to_lang": "zh"
|
||
}
|
||
```
|
||
|
||
- **请求参数说明**:
|
||
- `query`: 待翻译的文本
|
||
- `from_lang`: 源语言，支持值: `auto`(自动检测), `fr`(法语), `jp`(日语), `zh`(中文)，默认为 `auto`
|
||
- `to_lang`: 目标语言，支持值: `fr`(法语), `jp`(日语), `zh`(中文)，默认为 `zh`，不能为 `auto`
|
||
|
||
- **响应**:
|
||
|
||
```json
|
||
{
|
||
"translated_text": "你好世界"
|
||
}
|
||
```
|
||
|
||
- **状态码**:
|
||
- `200`: 翻译成功
|
||
- `401`: 未授权
|
||
- `500`: 翻译服务错误
|
||
|
||
#### 3.2 调试翻译接口
|
||
|
||
- **接口**: `POST /translate/debug`
|
||
- **描述**: 管理员专用的翻译调试接口，带有限流保护
|
||
- **需要认证**: 管理员权限
|
||
- **查询参数**:
|
||
- `query`: 待翻译文本
|
||
- `from_lang`: 源语言，默认为 `auto`
|
||
- `to_lang`: 目标语言，默认为 `zh`
|
||
|
||
- **限制**: 每秒最多2次请求
|
||
- **状态码**:
|
||
- `200`: 翻译成功
|
||
- `429`: 请求频率过高
|
||
- `403`: 权限不足
|
||
|
||
---
|
||
|
||
### 4. Redis测试模块 (`/ping-redis`)
|
||
|
||
#### 4.1 Redis连接测试
|
||
|
||
- **接口**: `GET /ping-redis`
|
||
- **描述**: 测试Redis连接状态
|
||
- **需要认证**: 否
|
||
- **响应**:
|
||
|
||
```json
|
||
{
|
||
"pong": true
|
||
}
|
||
```
|
||
|
||
---
|
||
|
||
### 5. 管理员模块 (`/admin`)
|
||
|
||
> **注意**: 所有管理员接口都需要管理员权限
|
||
|
||
#### 5.1 获取词典列表
|
||
|
||
- **接口**: `GET /admin/dict`
|
||
- **描述**: 分页获取词典数据，用于后台管理
|
||
- **需要认证**: 管理员权限
|
||
- **查询参数**:
|
||
- `page`: 页码 (默认: 1, 最小: 1)
|
||
- `page_size`: 每页条数 (默认: 10, 最大: 10)
|
||
- `lang_code`: 语言代码 ("fr" | "jp", 默认: "fr")
|
||
|
||
- **响应**:
|
||
|
||
```json
|
||
{
|
||
"total": "integer",
|
||
"data": [
|
||
{
|
||
"word__text": "string",
|
||
"pos": "string",
|
||
"meaning": "string",
|
||
"example": "string",
|
||
"eng_explanation": "string"
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
#### 5.2 搜索词条
|
||
|
||
- **接口**: `POST /admin/dict/search_word`
|
||
- **描述**: 在后台管理中搜索特定词条
|
||
- **需要认证**: 管理员权限
|
||
- **请求体**:
|
||
|
||
```json
|
||
{
|
||
"word": "string",
|
||
"language": "fr" | "jp",
|
||
"pos": "string"
|
||
}
|
||
```
|
||
|
||
- **响应**:
|
||
|
||
```json
|
||
[
|
||
{
|
||
"id": "integer",
|
||
"word": "string",
|
||
"pos": "string",
|
||
"meaning": "string",
|
||
"example": "string",
|
||
"eng_explanation": "string"
|
||
}
|
||
]
|
||
```
|
||
|
||
#### 5.3 批量更新词条
|
||
|
||
- **接口**: `PUT /admin/dict/adjust`
|
||
- **描述**: 批量更新词典定义内容
|
||
- **需要认证**: 管理员权限
|
||
- **请求体**:
|
||
|
||
```json
|
||
{
|
||
"updates": [
|
||
{
|
||
"id": "integer",
|
||
"language": "fr" | "jp",
|
||
"pos": "string",
|
||
"meaning": "string",
|
||
"example": "string",
|
||
"eng_explanation": "string"
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
- **响应**:
|
||
|
||
```json
|
||
{
|
||
"success_count": "integer",
|
||
"errors": ["string"]
|
||
}
|
||
```
|
||
|
||
- **状态码**:
|
||
- `200`: 更新成功
|
||
- `400`: 词条不存在
|
||
- `422`: 无改动信息
|
||
|
||
#### 5.4 添加新词条
|
||
|
||
- **接口**: `POST /admin/dict/add`
|
||
- **描述**: 添加新的词典条目
|
||
- **需要认证**: 管理员权限
|
||
- **请求体**:
|
||
|
||
```json
|
||
{
|
||
"word": "string",
|
||
"language": "fr" | "jp",
|
||
"pos": "string",
|
||
"meaning": "string",
|
||
"example": "string",
|
||
"eng_explanation": "string"
|
||
}
|
||
```
|
||
|
||
- **状态码**:
|
||
- `200`: 添加成功
|
||
- `409`: 释义已存在
|
||
- `400`: 不支持的语言类型
|
||
|
||
#### 5.5 Excel批量导入
|
||
|
||
- **接口**: `POST /admin/dict/update_by_xlsx`
|
||
- **描述**: 通过Excel文件批量导入词典数据
|
||
- **需要认证**: 管理员权限
|
||
- **请求类型**: `multipart/form-data`
|
||
- **请求参数**:
|
||
- `file`: Excel文件 (.xlsx 或 .xls 格式)
|
||
|
||
- **响应**:
|
||
|
||
```json
|
||
{
|
||
"message": "导入成功"
|
||
}
|
||
```
|
||
|
||
- **状态码**:
|
||
- `200`: 导入成功
|
||
- `400`: 文件格式错误
|
||
- `500`: 导入失败
|
||
|
||
---
|
||
|
||
### 6. 数据模型
|
||
|
||
#### 6.1 法语词性枚举
|
||
|
||
```text
|
||
n. - 名词
|
||
n.f. - 阴性名词
|
||
n.m. - 阳性名词
|
||
v. - 动词
|
||
v.t. - 及物动词
|
||
v.i. - 不及物动词
|
||
adj. - 形容词
|
||
adv. - 副词
|
||
prep. - 介词
|
||
pron. - 代词
|
||
conj. - 连词
|
||
interj. - 感叹词
|
||
art. - 冠词
|
||
```
|
||
|
||
#### 6.2 日语词性枚举
|
||
|
||
```text
|
||
名词, 形容词, 形容动词, 连用, 一段动词, 五段动词,
|
||
助词, 自动词, 他动词, 接尾, 自他动词, 接续,
|
||
惯用, 感叹词, カ変, サ変, 连体, 量词, 代词
|
||
```
|
||
|
||
---
|
||
|
||
### 7. 错误码说明
|
||
|
||
| 状态码 | 说明 |
|
||
|--------|------|
|
||
| 200 | 请求成功 |
|
||
| 400 | 请求参数错误 |
|
||
| 401 | 未授权/令牌无效 |
|
||
| 403 | 权限不足 |
|
||
| 404 | 资源未找到 |
|
||
| 409 | 资源冲突（如重复数据） |
|
||
| 422 | 请求实体错误 |
|
||
| 429 | 请求频率过高 |
|
||
| 500 | 服务器内部错误 |
|
||
|
||
---
|
||
|
||
### 8. AI助手模块 (`/ai_assist`)
|
||
|
||
#### 8.1 词语智能问答
|
||
|
||
- **接口**: `POST /ai_assist/exp`
|
||
- **描述**: 针对指定词语，向AI助手提问相关问题，获取简洁自然的答案，适合初学者。
|
||
- **需要认证**: 是
|
||
- **请求体**:
|
||
|
||
```json
|
||
{
|
||
"word": "string",
|
||
"question": "string"
|
||
}
|
||
```
|
||
|
||
- **响应**:
|
||
|
||
```json
|
||
{
|
||
"word": "string",
|
||
"answer": "string",
|
||
"model": "string",
|
||
"tokens_used": "integer"
|
||
}
|
||
```
|
||
|
||
- **状态码**:
|
||
- `200`: 问答成功
|
||
- `400`: 本月API使用量已超
|
||
- `500`: AI调用失败
|
||
|
||
#### 8.2 清除词语聊天记录
|
||
|
||
- **接口**: `POST /ai_assist/clear`
|
||
- **描述**: 清除指定词语的AI助手聊天记录
|
||
- **需要认证**: 是
|
||
- **请求参数**:
|
||
- `word`: 词语 (string)
|
||
|
||
- **响应**:
|
||
|
||
```json
|
||
{
|
||
"msg": "已清除 <word> 的聊天记录"
|
||
}
|
||
```
|
||
|
||
- **状态码**:
|
||
- `200`: 清除成功
|
||
|
||
---
|
||
|
||
### 9. 使用示例
|
||
|
||
#### 完整的API调用流程示例
|
||
|
||
```bash
|
||
# 1. 用户注册
|
||
curl -X POST "http://127.0.0.1:8000/users/register" \
|
||
-H "Content-Type: application/json" \
|
||
-d '{
|
||
"username": "testuser",
|
||
"password": "password123",
|
||
"lang_pref": "fr"
|
||
}'
|
||
|
||
# 2. 用户登录
|
||
curl -X POST "http://127.0.0.1:8000/users/login" \
|
||
-H "Content-Type: application/json" \
|
||
-d '{
|
||
"name": "testuser",
|
||
"password": "password123"
|
||
}'
|
||
|
||
# 3. 使用返回的token进行词典搜索
|
||
curl -X POST "http://127.0.0.1:8000/search" \
|
||
-H "Content-Type: application/json" \
|
||
-H "Authorization: Bearer <your_token_here>" \
|
||
-d '{
|
||
"query": "bonjour",
|
||
"language": "fr"
|
||
}'
|
||
|
||
# 4. 使用翻译API
|
||
curl -X POST "http://127.0.0.1:8000/translate" \
|
||
-H "Content-Type: application/json" \
|
||
-H "Authorization: Bearer <your_token_here>" \
|
||
-d '{
|
||
"query": "Hello World",
|
||
"from_lang": "auto",
|
||
"to_lang": "zh"
|
||
}'
|
||
|
||
# 5. 测试Redis连接
|
||
curl -X GET "http://127.0.0.1:8000/ping-redis"
|
||
|
||
# 6. 词语智能问答
|
||
curl -X POST "http://127.0.0.1:8000/ai_assist/exp" \
|
||
-H "Content-Type: application/json" \
|
||
-H "Authorization: Bearer <your_token_here>" \
|
||
-d '{
|
||
"word": "法语",
|
||
"question": "什么是法语?"
|
||
}'
|
||
|
||
# 7. 清除词语聊天记录
|
||
curl -X POST "http://127.0.0.1:8000/ai_assist/clear" \
|
||
-H "Content-Type: application/json" \
|
||
-H "Authorization: Bearer <your_token_here>" \
|
||
-d '{
|
||
"word": "法语"
|
||
}'
|
||
```
|
||
|
||
---
|
||
|
||
### 9. 开发者说明
|
||
|
||
- **数据库**: 使用MySQL存储词典数据和用户信息
|
||
- **缓存**: 使用Redis进行token黑名单管理和API限流
|
||
- **认证**: JWT令牌有效期为2小时
|
||
- **翻译服务**: 集成百度翻译API，支持多语言互译
|
||
- **限流保护**: 翻译调试接口有每秒2次请求限制
|
||
- **文件上传**: 支持Excel格式的批量词典导入
|
||
- **CORS**: 支持本地开发环境跨域访问
|
||
- **API文档**: 启动服务后访问 `http://127.0.0.1:8000/docs` 查看Swagger文档
|
||
|
||
---
|
||
|
||
### 10. 部署说明
|
||
|
||
1. 安装依赖: `pip install -r requirements.txt`
|
||
2. 配置数据库连接 (settings.py)
|
||
3. 配置百度翻译API密钥 (BAIDU_APPID, BAIDU_APPKEY)
|
||
4. 启动Redis服务
|
||
5. 运行数据库迁移
|
||
6. 启动服务: `python main.py`
|
||
|
||
---
|
||
|
||
*文档版本: 2.0*
|
||
*最后更新: 2025年9月22日*
|