针对上一篇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":"成功"
}

状态码说明

        对应的接口第一版本已经梳理完毕，下次，我们分享需要的数据库的设计。

来源：https://www.cnblogs.com/leiziv5/p/15583704.html