# word-remember

**Repository Path**: hycnb/word-remember

## Basic Information

- **Project Name**: word-remember
- **Description**: 单词默写网站
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2025-05-14
- **Last Updated**: 2025-11-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# WORD-REMEMBER

## api说明

### 创建空单词表

请求方法：POST

路由：/api/create_word_sheet

请求体:

```json
{ "name": "单词表名称" }
```

返回：

```json
{
    "id": "单词表id",
    "message":"返回信息"
}
```

### 更改单词

请求方法：POST

路由：/api/change_word

请求体:

```json
{
    "word_sheet_id": "单词表id",
    "word":[]
}
```

返回：

```json
{ "message":"返回信息" }
```

### 获取单词表列表

请求方法：GET

路由：/api/get_word_sheets

#### 请求参数

| 参数名     | 类型   | 必填 | 默认值 | 描述                     | 有效范围       |
|------------|--------|------|--------|--------------------------|----------------|
| `page`     | int    | 否   | 1      | 请求的页码              | 大于等于 1     |
| `per_page` | int    | 否   | 10     | 每页返回的记录数        | 1-100（推荐） |

#### 响应格式

```json
{
    "data": [
        {
            "_id": "单词表id",
            "name": "单词表名称",
            "words": [],
            "count": 0,
            "created_at": "创建时间",
            "edit_at": "编辑时间"
        },
    ],
    "pagination": {
        "total": 23,
        "page": 2,
        "per_page": 5,
        "total_pages": 5
    }
}
```

字段说明：
- `data[]`: 单词表数组
  - `_id`: 唯一标识符（24位十六进制字符串）
  - `name`: 单词表名称
  - `words[]`: 单词数组
  - `count`: 单词数量
  - `created_at`: 创建时间（ISO 8601格式）
- `pagination`: 分页元数据
  - `total`: 总记录数
  - `page`: 当前页码
  - `per_page`: 每页记录数
  - `total_pages`: 总页数

## 获取单词列表

请求方法：POST

路由：/api/get_words

请求体：

```json
{"id": "单词表id"}
```

返回：

```json
{ "word":[] }
```

## 删除单词表

请求方法：DELETE

路由：/api/delete_word_sheet

请求体：

```json
{"id": ["单词表id1", "单词表id2"]}
```

返回：

```json
{ "message":"返回信息" }
```

## 搜索单词表

请求方法：GET

路由：/api/search_word_sheet

请求参数：

|参数名|类型  |必填| 默认值|  描述  |
|-----|------|----|------|---------|
|query|string|是   |无   |搜索关键字|

返回：

```json
{
    "message":"返回信息",
    "data":[
        {
            "_id": "单词表id",
            "count": 0,
            "created_at": "创建时间",
            "name": "单词表名称",
            "edit_at": "编辑时间"
        }
    ]
}
```

## 单词tts

(此api目前不可用！实际它暂时也没有在项目中被用到)

请求方法：GET

路由：/api/tts

请求参数：

|参数名|类型  |必填| 默认值| 描述 |
|-----|------|----|------|-----|
|text |string|是   |无   |单词内容|

返回文件：voice.mp3