解决当前各系统间接口规范不统一问题
需要版本号(ansible接口建议新老版本间用版本号区别)
post get delete update up 只用post get
返回用json格式
基本返回值
{
"code": 500, 200 , 404,
"msg": "Something bad happened",
}
- api 接口必须加版本号，初始版本 【v1】,多个版本api版本可能同时在线
- 不使用rest的PUT和DELETE，因为很多浏览器不支持，很多框架也不支持
- POST在需要传输大量数据的时候使用，其余使用GET就可以了 参数数量和长度给一个值
- 所有路径path全部小写，以下划线分隔，所有参数，包括POST里面的body，以及header使用驼峰。例如：http://127.0.0.1/v1/wechat/mch_info/list_mch_info?page=2&perPage=100
- 用json格式返回
- 使用Token令牌来做用户身份的校验与权限分级
- 需要外部调用的部门内api 例如钉钉回调地址 必须走API网关
错误处理
不要直接将异常抛给客户端处理，一般需要一个统一的异常处理类，并且以统一格式将异常信息返回前端，统一格式参照目录“Response”
错误编码格式
https://open.weibo.com/wiki/Error_code
参照微博api 将api错误分级
code代码说明
200：解释
500 ：解释
404：解释
{
"code": 500,
"msg": "Something bad happened",
}
网友评论