开发规范
版本控制git
开发流程git flow
接口
| 请求方式 | url | 动作 | 中文说明 |
|---|---|---|---|
| GET | /resources/ |
list | 列表 |
| POST | /resources/ |
create | 创建 |
| GET | /resources/:id |
retrieve | 详细 |
| PUT | /resources/:id |
update | 更新 |
| PATCH | /resources/:id |
partial_update | 部分更新 |
| DELETE | /resources/:id |
destroy | 删除 |
数据
请求支持form-date,json,x-www-form-urlencode
返回格式统一为json
一个请求对应一个serializer
错误
错误信息包含在返回内容里
不同的错误对应不同的错误信息代码
http错误码按照标准用法使用
认证
jwt
token
oauth2
权限
以中间件形式作为权限鉴别插件，根据http请求格式直接判断权限
用户登录成功时，将用户信息与权限信息缓存保证效率
日志
日志以中间件形式提供
根据业务需求氛围入库日志与普通日志
文档(待完善)
根据上面的接口格式写文档
{
"resources": {
"list": {
"params": {},
"response": {}
},
"create": {
"request": {},
"response": {}
},
"retrieve": {
"response": {}
},
"update": {
"request": {},
"response": {}
},
"partial_update": {
"request": {},
"response": {}
},
"destroy": {}
}
}测试
业务所需接口测试覆盖率100%
部署
docker
docker-compose
docker-machine
docker-swarm
服务器资源监控
待完善
有疑问加站长微信联系（非本文作者）
