diff --git a/README.md b/README.md new file mode 100644 index 0000000..5ffc48e --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +# 爱特展示网 + +这次我们负责的项目是爱特展示网,后端接口要求如下: + +虽然这次接口数量不是很多,且多为GET请求。但是这次的成品会面向**22级新生**。主要的问题如下: +- 访问量和访问数据很大 +- 考验服务器和cdn加速的能力 +- 后端对报名信息和弹幕的合法性验证, +- 接口各种异常信息 +- 信息的处理和储存 +- Admin管理页面的优化 +- 等等 + +关于接口访问频率,目前暂定是**每秒三次** + +HTTP状态码规范: +- 200 请求成功 +- 400 请求失败 +- 404 找不到资源 +- 500 服务器超时 +- ....... + +具体状态码与报错信息绑定,且唯一确定,需要增加新的错误代码时需要在这里和工具函数里添加 +> 410XX 缺少某些参数 +> 420XX 传入数据格式不合法 +> 430XX 某些参数已存在 +> 440XX 传入参数错误 +> 450XX 访问资源不存在 +> 50XXX 服务器方面错误 +- 20000 成功 +- 50000 意外错误 +- 50403 Forbidden +- 40000 请求方法错误 +- 40001 JSON解析错误 +- 45030 信息不存在 +- 45032 邮箱验证码过期 +- 44031 邮箱验证码错误 +- 44032 请先发送验证码 +- 43032 该邮箱已存在 +- 43033 该手机号码已存在 +- 42033 手机号码不合规 +- 42034 姓名过长 +- 42035 说的太多啦 +- 42032 邮箱过长 +- 44033 请勿频繁发送验证码 +- 44036 请输入正确格式的邮箱 +- 42001 弹幕含有非法字符 +- 42002 弹幕过长 +- 42003 输入不能为空 +- 45004 获取的评论数为零 +- 45005 获取的部门作品数为零 +- 42006 不合法年级输入 + +大概规范就是这些,还有尽量使用DRF的类视图,还有学长的Django-Util,命名尽量使用下划线+小写字母