針對上一篇FastAPI（六十二）實戰開發《在線課程學習系統》需求分析需求的功能，我們對需要的接口進行梳理，大概的規劃出來現有的接口，作為我們第一版的接口的設計出版，然后我們根據設計的接口。

創新互聯建站堅持“要么做到，要么別承諾”的工作理念，服務領域包括：成都做網站、網站建設、企業官網、英文網站、手機端網站、網站推廣等服務，滿足客戶于互聯網時代的桓仁網站設計、移動媒體設計的需求，幫助企業找到有效的互聯網解決方案。努力成為您成熟可靠的網絡建設合作伙伴！

　　

2.1用戶注冊接口

路徑：/user/register

請求方式：POST

請求格式：json

是否依賴登陸：否

參數：

參數名稱	參數含義	參數是否必須	參數類型
username	用戶名 8-16位	是	str
password	密碼，長度8-16位，md5加密	是	str
role	類型，學生或者老師，默認：學生	是	str
jobnum	工號，8位數字	否	int
studentnum	學籍號，16位數字	否	int
sex	性別，男女。	是	str
age	年齡，必須大于18，小于65	是	int

接口返回：json

{
"code":200,
"data":'成功',
"message":"成功"
}

返回碼說明

代碼	含義
200	注冊成功
	注冊失敗
	身份和對應號不匹配
	年紀大小不符合
	用戶名重復
	密碼加密失敗
	用戶名長度不符合

2.2登陸接口

路徑：/user/login

請求方式：post

請求格式：json

是否依賴登陸：否

請求參數

字段	含義	是否必須	類型
username	用戶名	是	str
password	密碼	是	str

返回例子

{
"code":200,
"data":{
 "token":""
},
"message":"成功"
}

返回狀態碼說明

代碼	含義
200	成功
	登陸失敗
	重復登陸
	產生token失敗
	輸入密碼錯誤次數過多，賬號暫時鎖定，請30min再來登錄
	用戶不存在
	密碼錯誤

2.3個人信息

路徑：/user/info

請求方式：post

請求格式：json

請求參數：無

是否依賴登陸：是

返回格式：json

{
"code":200,
"data":{
 
},
"message":"成功"
}

返回狀態碼說明

代碼	含義
200	成功

2.4 修改密碼

路徑：/user/changepassword

請求方式：post

請求格式：json

返回格式：json

是否依賴登陸：是

參數	說明	是否必須	類型
oldpassword	原密碼	是	str
newspassword	新密碼	是	str

返回示例

{
"code":200,
"data":'成功',
"message":"成功"
}

返回狀態碼說明

狀態碼	含義
200	成功
	原密碼校驗失敗
	密碼保存失敗
	新密碼長度不匹配
	新舊密碼不能一樣

2.5 留言

路徑：/user/addmessage

請求方式：post

請求格式：json

是否依賴登陸：是

請求參數：

參數	含義	是否必須	類型
id	用戶id	是	int
message	內容	是	str

返回格式：json

{
"code":200,
"data":{
 
},
"message":"成功"
}

返回狀態碼說明

狀態碼	含義
200	成功
	自己不能給自己留言
	留言長度在5-500個字符長度
	留言用戶不存在

2.6 查看留言

路徑：/user/viewmessage

請求方式：get

請求格式：json

是否依賴登陸：是

請求參數：無

返回格式：json

{
"code":200,
"data":{
 
},
"message":"成功"
}

返回狀態碼說明

狀態碼	含義
200	成功

2.7留言列表

路徑：/user/messagelist

請求方式：get

請求格式：json

是否依賴登陸：是

請求參數：無

返回格式：json

{
"code":200,
"data":[
 
],
"message":"成功"
}

返回狀態碼說明

狀態碼	含義
200	成功

2.8回復留言

路徑：/user/rebackmessage/

請求方式：post

請求格式：json

是否依賴登陸：是

請求參數

參數	含義	是否必須	類型
id	留言的id	是	int
message	內容	是	str

返回格式：json

{
"code":200,
"data":{},
"message":"成功"
}

返回狀態碼說明

狀態碼	含義
200	成功
	回復留言失敗
	回復留言內容不能為空
	回復內容應該在5-500字
	回復留言id不存在

2.9刪除留言

路徑：/user/deletemessage/{id}

請求方式：get

請求格式：json

是否依賴登陸：是

請求參數：

參數	含義	是否必須	類型
id	留言的id	是	int

返回格式：json

{
"code":200,
"data":"ok",
"message":"成功"
}

返回狀態碼說明

狀態碼	含義
200	成功
	刪除留言不存在
	權限不足

2.10創建課程

路徑：/course/create

請求方式：post

請求格式：json

是否依賴登陸：是

請求參數：

參數	含義	是否必須	類型
name	課程名稱（長度2-50）	是	str
icon	課程的icon	否	str
desc	描述	否	text
catalog	目錄	否	json
onshelf	是否上架（0上架，1下架）	是	int

返回格式：json

{
"code":200,
"data":"ok",
"message":"成功"
}

狀態碼說明

狀態碼	含義
200	成功
	課程名稱不能重復
	課程創建失敗

2.11課程詳情

路徑：/course/detail/{id}

請求方式：get

請求格式：json

是否依賴登陸：是

請求參數

參數	含義	是否必須	類型
id	課程id	是	int

返回格式：json

{
"code":200,
"data":"ok",
"message":"成功"
}

狀態碼說明

狀態碼	含義
200	成功
	課程不存在

2.12 課程編輯

路徑：/course/edit

請求方式：put

請求格式：json

是否依賴登陸：是

請求參數

參數	含義	是否必須	類型
name	課程名稱（長度2-50）	是	str
id	課程id	是	int
icon	課程icon	否	str
desc	課程描述	否	str
catalog	課程目錄	否	json
onshelf	是否上架（0上架，1下架）	是	int

返回格式：json

{
"code":200,
"data":"ok",
"message":"成功"
}

狀態碼說明

狀態碼	含義
200	成功
	課程id不存在
	權限不足
	課程名稱不能重復

2.13 查看評論

路徑：/course/viewcomments/{id}

請求方式：get

請求格式：無

是否依賴登陸：是

請求參數

參數	含義	是否必須	類型
id	課程id	是	int

返回格式：json

{
"code":200,
"data":"ok",
"message":"成功"
}

狀態碼說明

狀態碼	含義
200	成功
	課程id不存在

2.14評論

路徑：/course/comments

請求方式：post

請求格式：json

是否依賴登陸：是

請求參數

參數	含義	是否必須	類型
id	課程id	是	int
content	評論內容	是	str

返回格式：json

{
"code":200,
"data":"ok",
"message":"成功"
}

狀態碼說明

狀態碼	含義
200	成功
	課程id不存在
	評論內容不能為空
	評論失敗
	自己不能評論自己的課程

2.15 加入課程

路徑：/course/add/{id}

請求方式：post

請求格式：json

是否依賴登陸：是

請求參數

參數	含義	是否必須	類型
id	課程id	是	int

返回格式：json

{
"code":200,
"data":"ok",
"message":"成功"
}

狀態碼說明

狀態碼	含義
200	成功
	課程id不存在
	課程不能重復加入
	自己不能加入自己的課程

2.16 退出課程

路徑：/course/quit/{id}

請求方式：post

請求格式：json

是否依賴登陸：是

請求參數

參數	含義	是否必須	類型
id	課程id	是	int

返回格式：json

{
"code":200,
"data":"ok",
"message":"成功"
}

狀態碼說明

狀態碼	含義
200	成功
	課程id不存在
	課程不在自己列表

2.17 課程列表

路徑：/course/list

請求方式：get

請求格式：json

是否依賴登陸：是

請求參數：無

返回格式：json

{
"code":200,
"data":"ok",
"message":"成功"
}

狀態碼說明

狀態碼	含義
200	成功

2.18 課程列表（當前用戶的課程）

路徑：/course/courselist

請求方式：get

請求格式：json

是否依賴登陸：是

請求參數：

無

返回格式：json

{
"code":200,
"data":"ok",
"message":"成功"
}

狀態碼說明

狀態碼	含義
200	成功

2.19 推薦課程列表

路徑：/course/recommend

請求方式：get

請求格式：json

是否依賴登陸：是

請求參數：無

返回格式：json

{
"code":200,
"data":"ok",
"message":"成功"
}

狀態碼說明

狀態碼	含義
200	成功

2.20 課程點贊

路徑：/course/like/{id}

請求方式：get

請求格式：json

是否依賴登陸：是

請求參數

參數	含義	是否必須	類型
id	課程id	是	int

返回格式：json

{
"code":200,
"data":"ok",
"message":"成功"
}

2.21 課程上架

路徑：/course/onshelf/{id}

請求方式：get

請求格式：json

是否依賴登陸：是

請求參數

參數	含義	是否必須	類型
id	課程id	是	int

返回格式：json

{
"code":200,
"data":"ok",
"message":"成功"
}

狀態碼說明

狀態碼	含義
200	成功
	課程不存在
	課程已經上架
	自己只能上架自己的課程
	權限不足

2.22 課程下架

路徑：/course/offshelf/{id}

請求方式：get

請求格式：json

是否依賴登陸：是

請求參數

參數	含義	是否必須	類型
id	課程id	是	int

返回格式：json

{
"code":200,
"data":"ok",
"message":"成功"
}

狀態碼說明

狀態碼	含義
200	成功
	課程不存在
	課程已經下架
	自己只能下架自己的課程
	權限不足

對應的接口第一版本已經梳理完畢，下次，我們分享需要的數據庫的設計。

后記

文章首發在公眾號，歡迎關注。

網站題目：FastAPI（六十三）實戰開發《在線課程學習系統》梳理系統需要接口
瀏覽地址：http://www.xueling.net.cn/article/dsojsoh.html