以下规范仅供参考,请以实际开发需求进行调整。
xxx项目服务端开发规范文档
前言
技术选型
服务端:NodeJS(使用ThinkJS框架)
客户端:vuejs(ElementUI)/webpack
数据库:MySQL
接口规范
Http通信
- 通信数据格式:JSON
- HTTP请求:统一使用Post
命名规范
- 接口命名:统一使用小驼峰
,如addPet
- 私有方法命名:统一使用_下划线 + 小驼峰方法名
,如:_getParents
- 接口参数命名:统一使用小写字母 + '_'下划线分隔
,如:user_id
- 文件命名:统一使用小写字母 + '_'下划线分隔
,如:user_model.js
- 变量命名:统一使用小驼峰
,如addPet
接口返回数据格式
{
"status": 0, // 接口调用状态码,0表示成功,非0表示失败,或为其他状态;具体以接口文档为主
"data": {
"desc": "接口返回的所有数据统一放此键值中",
"key_name_desc": "键名统一使用[小写字母 + _下划线分隔]"
},
"msg": "接口返回消息,如:xxx成功/失败"
}
接口文档
使用PostmanAPI文档工具。请保持文档与实际开发接口、参数说明等信息的一致性!及时更新!
数据库规范
详见wiki中的《MySQL数据库规范》
测试服务器
局域网测试服务器:172.17.10.222:8001
外网测试服务器:42.101.71.17:8