摘要:針對上一篇六十二實戰開發在線課程學習系統需求分析需求的功能,我們對需要的接口進行梳理,大概的規劃出來現有的接口,作為我們第一版的接口的設計出版,然后我們根據設計的接口。后記文章首發在公眾號,歡迎關注。
針對上一篇FastAPI(六十二)實戰開發《在線課程學習系統》需求分析需求的功能,我們對需要的接口進行梳理,大概的規劃出來現有的接口,作為我們第一版的接口的設計出版,然后我們根據設計的接口。
路徑:/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 | 注冊成功 |
100101 | 注冊失敗 |
100102 | 身份和對應號不匹配 |
100103 | 年紀大小不符合 |
100104 | 用戶名重復 |
100105 | 密碼加密失敗 |
100106 | 用戶名長度不符合 |
路徑:/user/login
請求方式:post
請求格式:json
是否依賴登陸:否
請求參數
字段 | 含義 | 是否必須 | 類型 |
---|---|---|---|
username | 用戶名 | 是 | str |
password | 密碼 | 是 | str |
返回例子
{
"code":200,
"data":{
"token":""
},
"message":"成功"
}
返回狀態碼說明
代碼 | 含義 |
---|---|
200 | 成功 |
100201 | 登陸失敗 |
100202 | 重復登陸 |
100203 | 產生token失敗 |
100204 | 輸入密碼錯誤次數過多,賬號暫時鎖定,請30min再來登錄 |
100205 | 用戶不存在 |
100206 | 密碼錯誤 |
路徑:/user/info
請求方式:post
請求格式:json
請求參數:無
是否依賴登陸:是
返回格式:json
{
"code":200,
"data":{
},
"message":"成功"
}
返回狀態碼說明
代碼 | 含義 |
---|---|
200 | 成功 |
路徑:/user/changepassword
請求方式:post
請求格式:json
返回格式:json
是否依賴登陸:是
參數 | 說明 | 是否必須 | 類型 |
---|---|---|---|
oldpassword | 原密碼 | 是 | str |
newspassword | 新密碼 | 是 | str |
返回示例
{
"code":200,
"data":成功,
"message":"成功"
}
返回狀態碼說明
狀態碼 | 含義 |
---|---|
200 | 成功 |
100301 | 原密碼校驗失敗 |
100302 | 密碼保存失敗 |
100303 | 新密碼長度不匹配 |
100304 | 新舊密碼不能一樣 |
路徑:/user/addmessage
請求方式:post
請求格式:json
是否依賴登陸:是
請求參數:
參數 | 含義 | 是否必須 | 類型 |
---|---|---|---|
id | 用戶id | 是 | int |
message | 內容 | 是 | str |
返回格式:json
{
"code":200,
"data":{
},
"message":"成功"
}
返回狀態碼說明
狀態碼 | 含義 |
---|---|
200 | 成功 |
100501 | 自己不能給自己留言 |
100502 | 留言長度在5-500個字符長度 |
100503 | 留言用戶不存在 |
路徑:/user/viewmessage
請求方式:get
請求格式:json
是否依賴登陸:是
請求參數:無
返回格式:json
{
"code":200,
"data":{
},
"message":"成功"
}
返回狀態碼說明
狀態碼 | 含義 |
---|---|
200 | 成功 |
路徑:/user/messagelist
請求方式:get
請求格式:json
是否依賴登陸:是
請求參數:無
返回格式:json
{
"code":200,
"data":[
],
"message":"成功"
}
返回狀態碼說明
狀態碼 | 含義 |
---|---|
200 | 成功 |
路徑:/user/rebackmessage/
請求方式:post
請求格式:json
是否依賴登陸:是
請求參數
參數 | 含義 | 是否必須 | 類型 |
---|---|---|---|
id | 留言的id | 是 | int |
message | 內容 | 是 | str |
返回格式:json
{
"code":200,
"data":{},
"message":"成功"
}
返回狀態碼說明
狀態碼 | 含義 |
---|---|
200 | 成功 |
100801 | 回復留言失敗 |
100802 | 回復留言內容不能為空 |
100803 | 回復內容應該在5-500字 |
100804 | 回復留言id不存在 |
路徑:/user/deletemessage/{id}
請求方式:get
請求格式:json
是否依賴登陸:是
請求參數:
參數 | 含義 | 是否必須 | 類型 |
---|---|---|---|
id | 留言的id | 是 | int |
返回格式:json
{
"code":200,
"data":"ok",
"message":"成功"
}
返回狀態碼說明
狀態碼 | 含義 |
---|---|
200 | 成功 |
100901 | 刪除留言不存在 |
100902 | 權限不足 |
路徑:/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 | 成功 |
101002 | 課程名稱不能重復 |
101003 | 課程創建失敗 |
路徑:/course/detail/{id}
請求方式:get
請求格式:json
是否依賴登陸:是
請求參數
參數 | 含義 | 是否必須 | 類型 |
---|---|---|---|
id | 課程id | 是 | int |
返回格式:json
{
"code":200,
"data":"ok",
"message":"成功"
}
狀態碼說明
狀態碼 | 含義 |
---|---|
200 | 成功 |
101101 | 課程不存在 |
路徑:/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 | 成功 |
101201 | 課程id不存在 |
101202 | 權限不足 |
101203 | 課程名稱不能重復 |
路徑:/course/viewcomments/{id}
請求方式:get
請求格式:無
是否依賴登陸:是
請求參數
參數 | 含義 | 是否必須 | 類型 |
---|---|---|---|
id | 課程id | 是 | int |
返回格式:json
{
"code":200,
"data":"ok",
"message":"成功"
}
狀態碼說明
狀態碼 | 含義 |
---|---|
200 | 成功 |
101301 | 課程id不存在 |
路徑:/course/comments
請求方式:post
請求格式:json
是否依賴登陸:是
請求參數
參數 | 含義 | 是否必須 | 類型 |
---|---|---|---|
id | 課程id | 是 | int |
content | 評論內容 | 是 | str |
返回格式:json
{
"code":200,
"data":"ok",
"message":"成功"
}
狀態碼說明
狀態碼 | 含義 |
---|---|
200 | 成功 |
101401 | 課程id不存在 |
101402 | 評論內容不能為空 |
101403 | 評論失敗 |
101404 | 自己不能評論自己的課程 |
路徑:/course/add/{id}
請求方式:post
請求格式:json
是否依賴登陸:是
請求參數
參數 | 含義 | 是否必須 | 類型 |
---|---|---|---|
id | 課程id | 是 | int |
返回格式:json
{
"code":200,
"data":"ok",
"message":"成功"
}
狀態碼說明
狀態碼 | 含義 |
---|---|
200 | 成功 |
101501 | 課程id不存在 |
101502 | 課程不能重復加入 |
101503 | 自己不能加入自己的課程 |
路徑:/course/quit/{id}
請求方式:post
請求格式:json
是否依賴登陸:是
請求參數
參數 | 含義 | 是否必須 | 類型 |
---|---|---|---|
id | 課程id | 是 | int |
返回格式:json
{
"code":200,
"data":"ok",
"message":"成功"
}
狀態碼說明
狀態碼 | 含義 |
---|---|
200 | 成功 |
101601 | 課程id不存在 |
101602 | 課程不在自己列表 |
路徑:/course/list
請求方式:get
請求格式:json
是否依賴登陸:是
請求參數:無
返回格式:json
{
"code":200,
"data":"ok",
"message":"成功"
}
狀態碼說明
狀態碼 | 含義 |
---|---|
200 | 成功 |
路徑:/course/courselist
請求方式:get
請求格式:json
是否依賴登陸:是
請求參數:
無
返回格式:json
{
"code":200,
"data":"ok",
"message":"成功"
}
狀態碼說明
狀態碼 | 含義 |
---|---|
200 | 成功 |
路徑:/course/recommend
請求方式:get
請求格式:json
是否依賴登陸:是
請求參數:無
返回格式:json
{
"code":200,
"data":"ok",
"message":"成功"
}
狀態碼說明
狀態碼 | 含義 |
---|---|
200 | 成功 |
路徑:/course/like/{id}
請求方式:get
請求格式:json
是否依賴登陸:是
請求參數
參數 | 含義 | 是否必須 | 類型 |
---|---|---|---|
id | 課程id | 是 | int |
返回格式:json
{
"code":200,
"data":"ok",
"message":"成功"
}
路徑:/course/onshelf/{id}
請求方式:get
請求格式:json
是否依賴登陸:是
請求參數
參數 | 含義 | 是否必須 | 類型 |
---|---|---|---|
id | 課程id | 是 | int |
返回格式:json
{
"code":200,
"data":"ok",
"message":"成功"
}
狀態碼說明
狀態碼 | 含義 |
---|---|
200 | 成功 |
102101 | 課程不存在 |
102102 | 課程已經上架 |
102103 | 自己只能上架自己的課程 |
102104 | 權限不足 |
路徑:/course/offshelf/{id}
請求方式:get
請求格式:json
是否依賴登陸:是
請求參數
參數 | 含義 | 是否必須 | 類型 |
---|---|---|---|
id | 課程id | 是 | int |
返回格式:json
{
"code":200,
"data":"ok",
"message":"成功"
}
狀態碼說明
狀態碼 | 含義 |
---|---|
200 | 成功 |
102201 | 課程不存在 |
102202 | 課程已經下架 |
102203 | 自己只能下架自己的課程 |
102204 | 權限不足 |
對應的接口第一版本已經梳理完畢,下次,我們分享需要的數據庫的設計。
后記
文章首發在公眾號,歡迎關注。
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/124530.html
摘要:為了方便大家了解并入門微信小程序,我將一些可能會需要的知識,列在這里,讓大家方便的從零開始學習一微信小程序的特點張小龍張小龍全面闡述小程序,推薦通讀此文小程序是一種不需要下載安裝即可使用的應用,它出現了觸手可及的夢想,用戶掃一掃或者搜一下即 為了方便大家了解并入門微信小程序,我將一些可能會需要的知識,列在這里,讓大家方便的從零開始學習; 一:微信小程序的特點 張小龍:張小龍全面闡述小程...
摘要:為了方便大家了解并入門微信小程序,我將一些可能會需要的知識,列在這里,讓大家方便的從零開始學習一微信小程序的特點張小龍張小龍全面闡述小程序,推薦通讀此文小程序是一種不需要下載安裝即可使用的應用,它出現了觸手可及的夢想,用戶掃一掃或者搜一下即 為了方便大家了解并入門微信小程序,我將一些可能會需要的知識,列在這里,讓大家方便的從零開始學習; 一:微信小程序的特點 張小龍:張小龍全面闡述小程...
摘要:為了方便大家了解并入門微信小程序,我將一些可能會需要的知識,列在這里,讓大家方便的從零開始學習一微信小程序的特點張小龍張小龍全面闡述小程序,推薦通讀此文小程序是一種不需要下載安裝即可使用的應用,它出現了觸手可及的夢想,用戶掃一掃或者搜一下即 為了方便大家了解并入門微信小程序,我將一些可能會需要的知識,列在這里,讓大家方便的從零開始學習; 一:微信小程序的特點 張小龍:張小龍全面闡述小程...
FastAPI是個現代化的,迅速(性能卓越)pythonweb架構。本文運用fastapi完成上傳圖片作用,文章中的實例編碼解讀詳盡,所需要的可以了解一下 應用File完成文件傳送 應用Form表格上傳圖片,fastapi應用File獲得上傳文檔。 特定了參數類型是bytes:file:bytes=File(),這時會把文件所有載入到內存條,較為適合靜態資源。 應用File要提前組裝p...
閱讀 713·2023-04-25 19:43
閱讀 3910·2021-11-30 14:52
閱讀 3784·2021-11-30 14:52
閱讀 3852·2021-11-29 11:00
閱讀 3783·2021-11-29 11:00
閱讀 3869·2021-11-29 11:00
閱讀 3557·2021-11-29 11:00
閱讀 6105·2021-11-29 11:00