文章目錄

• • title: 單詞學習系統 v1.0.0
• 單詞學習系統
• Default
• • GET 翻譯接口
  • • 請求參數
    • 返回結果
    • 返回數據結構
  • GET 查詢單詞列表
  • • 請求參數
    • 返回結果
    • 返回數據結構
  • GET 獲取書籍種類
  • • 返回結果
    • 返回數據結構
• 用戶操作
• • POST 登錄
  • • 請求參數
    • 返回結果
    • 返回數據結構
  • POST 注冊
  • • 請求參數
    • 返回結果
    • 返回數據結構
  • GET 獲取用戶信息
  • • 返回結果
    • 返回數據結構
  • POST 修改密碼
  • • 請求參數
    • 返回結果
    • 返回數據結構
  • POST 修改用戶信息
  • • 請求參數
    • 返回結果
    • 返回數據結構
• 管理員操作
• • POST 修改用戶信息
  • • 請求參數
    • 返回結果
    • 返回數據結構
  • GET 刪除用戶
  • • 請求參數
    • 返回結果
    • 返回數據結構
  • GET 查詢用戶列表
  • • 返回結果
    • 返回數據結構
• 單詞書
• • GET 修改為已復習
  • • 請求參數
    • 返回結果
    • 返回數據結構
  • GET 查詢用戶單詞書
  • • 請求參數
    • 返回結果
    • 返回數據結構
  • GET 刪除用戶書籍
  • • 請求參數
    • 返回結果
    • 返回數據結構
  • GET 新增用戶書籍
  • • 請求參數
    • 返回結果
    • 返回數據結構
  • GET 單個單詞插入
  • • 請求參數
    • 返回結果
    • 返回數據結構
• 單詞本
• • POST 新增數據
  • • 請求參數
    • 返回結果
    • 返回數據結構
  • GET 刪除
  • • 請求參數
    • 返回結果
    • 返回數據結構
  • POST 更新
  • • 請求參數
    • 返回結果
    • 返回數據結構
  • GET 獲取單詞本列表
  • • 返回結果
    • 返回數據結構
• 數據模型

---

title: 單詞學習系統 v1.0.0

單詞學習系統

v1.0.0

Default

GET 翻譯接口

GET /translate

請求參數

名稱位置類型必選說明

q	query	string	是	要翻譯的內容
from	query	string	是	被翻譯的語言是什么（zh中文，en英文）
to	query	string	是	要翻譯成什么語言（zh中文，en英文）

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

狀態碼 200

名稱類型必選約束中文名說明

? from	string	true	none		來源類型
? to	string	true	none		翻譯成什么語言
? trans_result	[object]	true	none		none
?? src	string	false	none		輸入語言
?? dst	string	false	none		輸出語言

GET 查詢單詞列表

GET /wordList/list

請求參數

名稱位置類型必選說明

bookType	query	string	否	書本查詢
initialType	query	string	否	單詞首字母(大寫)
keyword	query	string	否	關鍵詞檢索（中英文檢索）
page	query	string	否	頁數
limit	query	string	否	條數

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

狀態碼 200

名稱類型必選約束中文名說明

? status	integer	true	none		狀態碼
? success	boolean	true	none		none
? msg	string	true	none		說明
? data	object	true	none		返回數據
?? list	[object]	true	none		none
??? id	integer	true	none		單詞id
??? books	string	true	none		書名
??? initial	string	true	none		首字母
??? word	string	true	none		英文
??? chinese	string	true	none		翻譯
??? createTime	string	true	none		創建時間
??? isJotter	boolean	true	none		是否在單詞本中
??? isBook	boolean	true	none		是否在單詞書中
?? count	integer	true	none		數據總條數
?? isNextPage	boolean	true	none		是否有下一頁
? time	string	true	none		請求時間

GET 獲取書籍種類

GET /wordList/get/bookType

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

狀態碼 200

名稱類型必選約束中文名說明

? status	integer	true	none		狀態碼
? msg	string	true	none		狀態說明
? data	[object]	true	none		none
?? bookType	string	true	none		書名
?? isAdd	boolean	true	none		用戶是否已添加
? time	string	true	none		請求時間

用戶操作

POST 登錄

POST /user/login

Body 請求參數

{"username": "root","password": "123456" }

請求參數

名稱位置類型必選說明

body	body	object	否	none

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

POST 注冊

POST /user/register

Body 請求參數

{"name": "吾聽安","sex": "0","age": "22","username": "root","password": "123456","type": "0","phone": "13444444444","email": "2322234298@qq.com","realname": "奧特曼","img": "" }

請求參數

名稱位置類型必選說明

body	body	object	否	none

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

GET 獲取用戶信息

GET /user/getInfo

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

狀態碼 200

名稱類型必選約束中文名說明

? status	integer	true	none		響應碼
? success	boolean	true	none		none
? msg	string	true	none		none
? data	object	true	none		返回數據
?? uid	integer	true	none		用戶id
?? name	string	true	none		昵稱
?? sex	string	true	none		性別
?? age	integer	true	none		年齡
?? username	string	true	none		用戶名
?? password	null	true	none		密碼
?? createTime	string	true	none		創建時間
?? type	string	true	none		身份（0表示普通用戶，1表示管理員）
?? phone	string	true	none		電話號碼
?? email	string	true	none		郵箱
?? img	string	true	none		頭像鏈接
?? realname	string	true	none		真實姓名
? time	string	true	none		none

POST 修改密碼

POST /user/edit/password

Body 請求參數

"{\r\n \"password\":\"123456\"\r\n \"newPassword\":\"666666\"\r\n}"

請求參數

名稱位置類型必選說明

body	body	object	否	none

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

POST 修改用戶信息

POST /user/update

Body 請求參數

{"name": "吾聽安","sex": "0","age": "22","type": "0","phone": "13444444444","email": "2322234298@qq.com","realname": "奧特曼","img": "" }

請求參數

名稱位置類型必選說明

body	body	object	否	none

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

管理員操作

POST 修改用戶信息

POST /user/vip/update

請求參數

名稱位置類型必選說明

name	query	string	否	昵稱
sex	query	string	否	性別，0男 1女
age	query	string	否	年齡
username	query	string	否	賬號
type	query	string	否	用戶類型：0普通用戶，1管理員
phone	query	string	否	手機號
email	query	string	否	郵箱
realname	query	string	否	真實姓名

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

GET 刪除用戶

GET /user/del

請求參數

名稱位置類型必選說明

id	query	string	否	用戶id

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

GET 查詢用戶列表

GET /user

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

單詞書

GET 修改為已復習

GET /wordBook/update

請求參數

名稱位置類型必選說明

id	query	string	是	單詞書id
reviewStates	query	string	是	復習狀態：0待復習，1已復習

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

GET 查詢用戶單詞書

GET /wordBook/list

請求參數

名稱位置類型必選說明

limit	query	string	否	none
states	query	string	否	學習狀態 0未學，1已學
reviewStates	query	string	否	復習狀態：0待復習，1已復習
books	query	string	否	書籍分類

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

狀態碼 200

名稱類型必選約束中文名說明

? status	integer	true	none		狀態碼
? success	boolean	true	none		none
? msg	string	true	none		說明
? data	object	true	none		返回數據
?? list	[object]	true	none		數據集合
??? id	integer	true	none		單詞書id
??? uid	integer	true	none		用戶id
??? wordId	integer	true	none		單詞id
??? states	string	true	none		學習狀態（0是未學習，1是已學習）
??? reviewCount	integer	true	none		復習次數
??? createTime	string	true	none		上一次復習時間
??? reviewStates	string	true	none		復習狀態（0未復習，1已復習）
??? books	string	true	none		屬于什么書（環境）
??? initial	string	true	none		首字母
??? word	string	true	none		英語
??? chinese	string	true	none		翻譯
?? count	integer	true	none		數據總數
?? isNextPage	boolean	true	none		是否還有下一頁
? time	string	true	none		請求時間

GET 刪除用戶書籍

GET /wordBook/del/byBookType

請求參數

名稱位置類型必選說明

type	query	string	否	書籍名

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

GET 新增用戶書籍

GET /wordBook/add/byBookType

請求參數

名稱位置類型必選說明

type	query	string	否	書籍名稱

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

GET 單個單詞插入

GET /wordBook/addById

請求參數

名稱位置類型必選說明

id	query	string	是	單詞id
type	query	string	是	書籍名（要加入到的環境名）

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

單詞本

POST 新增數據

POST /jotter

請求參數

名稱位置類型必選說明

english	query	string	否	英語
chinese	query	string	否	中文

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

GET 刪除

GET /jotter/del

請求參數

名稱位置類型必選說明

id	query	string	否	單詞本id

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

POST 更新

POST /jotter/update

Body 請求參數

{"id": "2","english": "","chinese": "天哪" }

請求參數

名稱位置類型必選說明

body	body	object	否	none

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

GET 獲取單詞本列表

GET /jotter/list

返回示例

返回結果

狀態碼狀態碼含義說明數據模型

200	OK	成功	Inline

返回數據結構

狀態碼 200

名稱類型必選約束中文名說明

? status	integer	true	none		響應碼
? success	boolean	true	none		none
? msg	string	true	none		說明
? data	object	true	none		none
?? isNextPage	boolean	true	none		是否還有下一頁
?? count	integer	true	none		總條數
?? list	[object]	true	none		none
??? id	integer	false	none		單詞本id
??? uid	integer	false	none		用戶id
??? english	string	false	none		英文
??? chinese	string	false	none		中文翻譯
? time	string	true	none		請求時間

數據模型

總結

以上是生活随笔為你收集整理的单词系统文档的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。