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

2.1使用者註冊介面

路徑：/user/register

請求方式：POST

請求格式：json

是否依賴登陸：否

引數：

介面返回：json

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

返回碼說明

2.2登陸介面

路徑：/user/login

請求方式：post

請求格式：json

是否依賴登陸：否

請求引數

返回例子

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

返回狀態碼說明

2.3個人資訊

路徑：/user/info

請求方式：post

請求格式：json

請求引數：無

是否依賴登陸：是

返回格式：json

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

返回狀態碼說明

2.4 修改密碼

路徑：/user/changepassword

請求方式：post

請求格式：json

返回格式：json

是否依賴登陸：是

返回示例

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

返回狀態碼說明

2.5 留言

路徑：/user/addmessage

請求方式：post

請求格式：json

是否依賴登陸：是

請求引數：

返回格式：json

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

返回狀態碼說明

2.6 檢視留言

路徑：/user/viewmessage

請求方式：get

請求格式：json

是否依賴登陸：是

請求引數：無

返回格式：json

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

返回狀態碼說明

2.7留言列表

路徑：/user/messagelist

請求方式：get

請求格式：json

是否依賴登陸：是

請求引數：無

返回格式：json

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

返回狀態碼說明

2.8回覆留言

路徑：/user/rebackmessage/

請求方式：post

請求格式：json

是否依賴登陸：是

請求引數

返回格式：json

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

返回狀態碼說明

2.9刪除留言

路徑：/user/deletemessage/{id}

請求方式：get

請求格式：json

是否依賴登陸：是

請求引數：

返回格式：json

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

返回狀態碼說明

2.10建立課程

路徑：/course/create

請求方式：post

請求格式：json

是否依賴登陸：是

請求引數：

返回格式：json

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

狀態碼說明

2.11課程詳情

路徑：/course/detail/{id}

請求方式：get

請求格式：json

是否依賴登陸：是

請求引數

返回格式：json

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

狀態碼說明

2.12 課程編輯

路徑：/course/edit

請求方式：put

請求格式：json

是否依賴登陸：是

請求引數

返回格式：json

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

狀態碼說明

2.13 檢視評論

路徑：/course/viewcomments/{id}

請求方式：get

請求格式：無

是否依賴登陸：是

請求引數

返回格式：json

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

狀態碼說明

2.14評論

路徑：/course/comments

請求方式：post

請求格式：json

是否依賴登陸：是

請求引數

返回格式：json

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

狀態碼說明

2.15 加入課程

路徑：/course/add/{id}

請求方式：post

請求格式：json

是否依賴登陸：是

請求引數

返回格式：json

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

狀態碼說明

2.16 退出課程

路徑：/course/quit/{id}

請求方式：post

請求格式：json

是否依賴登陸：是

請求引數

返回格式：json

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

狀態碼說明

2.17 課程列表

路徑：/course/list

請求方式：get

請求格式：json

是否依賴登陸：是

請求引數：無

返回格式：json

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

狀態碼說明

2.18 課程列表（當前使用者的課程）

路徑：/course/courselist

請求方式：get

請求格式：json

是否依賴登陸：是

請求引數：

無

返回格式：json

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

狀態碼說明

2.19 推薦課程列表

路徑：/course/recommend

請求方式：get

請求格式：json

是否依賴登陸：是

請求引數：無

返回格式：json

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

狀態碼說明

2.20 課程點贊

路徑：/course/like/{id}

請求方式：get

請求格式：json

是否依賴登陸：是

請求引數

返回格式：json

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

2.21 課程上架

路徑：/course/onshelf/{id}

請求方式：get

請求格式：json

是否依賴登陸：是

請求引數

返回格式：json

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

狀態碼說明

2.22 課程下架

路徑：/course/offshelf/{id}

請求方式：get

請求格式：json

是否依賴登陸：是

請求引數

返回格式：json

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

狀態碼說明

對應的介面第一版本已經梳理完畢，下次，我們分享需要的資料庫的設計。

後記

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