FastAPI(六十三)实战开发《在线课程学习系统》梳理系统需要接口 (上)

简介: FastAPI(六十三)实战开发《在线课程学习系统》梳理系统需要接口 (上)

 针对上一篇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 注册成功
100101 注册失败
100102 身份和对应号不匹配
100103 年纪大小不符合
100104 用户名重复
100105 密码加密失败
100106 用户名长度不符合

 

2.2登陆接口


路径:/user/login


请求方式:post


请求格式:json


是否依赖登陆:否


请求参数


字段 含义 是否必须 类型
username 用户名 str
password 密码 str


返回例子


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


返回状态码说明

 

代码 含义
200 成功
100201 登陆失败
100202 重复登陆
100203 产生token失败
100204 输入密码错误次数过多,账号暂时锁定,请30min再来登录
100205 用户不存在
100206 密码错误

 

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 成功
100301 原密码校验失败
100302 密码保存失败
100303 新密码长度不匹配
100304 新旧密码不能一样


2.5 留言


路径:/user/addmessage


请求方式:post


请求格式:json


是否依赖登陆:是


请求参数:


参数 含义 是否必须 类型
id 用户id int
message 内容 str


返回格式:json


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


返回状态码说明


状态码 含义
200 成功
100501 自己不能给自己留言
100502 留言长度在5-500个字符长度
100503 留言用户不存在

 

2.6 查看留言


路径:/user/viewmessage


请求方式:get


请求格式:json


是否依赖登陆:是


请求参数:无


返回格式:json

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


返回状态码说明


状态码 含义
200 成功
相关文章
|
NoSQL Redis
使用slowapi对FastApi的接口进行限速
使用slowapi对FastApi的接口进行限速
1992 0
|
11月前
|
JSON API 数据格式
使用(Python)FastAPI快速构建你的后端接口服务
使用(Python)FastAPI快速构建你的后端接口服务
789 0
|
JSON 数据安全/隐私保护 数据格式
python fastapi 入门教程,每个案例都使用postman进行测试写的接口
python fastapi 入门教程,每个案例都使用postman进行测试写的接口
|
网络安全 Windows
基于fastapi实现6个接口(token拦截, 2个业务流程,接口参数依赖校验)已经通过postman测试,记录部署服务器和windows,用于pytest接口自动化框架的接口测试对象
基于fastapi实现6个接口(token拦截, 2个业务流程,接口参数依赖校验)已经通过postman测试,记录部署服务器和windows,用于pytest接口自动化框架的接口测试对象
|
NoSQL 测试技术 Redis
FastAPI(八十四)实战开发《在线课程学习系统》--接口测试(下)
FastAPI(八十四)实战开发《在线课程学习系统》--接口测试(下)
FastAPI(八十四)实战开发《在线课程学习系统》--接口测试(下)
|
测试技术 数据安全/隐私保护
FastAPI(八十四)实战开发《在线课程学习系统》--接口测试(上)
FastAPI(八十四)实战开发《在线课程学习系统》--接口测试(上)
|
存储 测试技术 数据安全/隐私保护
FastAPI(八十三)实战开发《在线课程学习系统》--注册接口单元测试
FastAPI(八十三)实战开发《在线课程学习系统》--注册接口单元测试
FastAPI(八十三)实战开发《在线课程学习系统》--注册接口单元测试
FastAPI(八十二)实战开发《在线课程学习系统》接口开发-- 课程上架下架
FastAPI(八十二)实战开发《在线课程学习系统》接口开发-- 课程上架下架
|
NoSQL Redis 数据库
FastAPI(八十一)实战开发《在线课程学习系统》接口开发-- 推荐课程列表与课程点赞
FastAPI(八十一)实战开发《在线课程学习系统》接口开发-- 推荐课程列表与课程点赞
FastAPI(八十)实战开发《在线课程学习系统》接口开发-- 课程列表
FastAPI(八十)实战开发《在线课程学习系统》接口开发-- 课程列表