接口规范定义:
-
数据格式
此数据格式统一的按照标准的json数据格式返回。
例:
{
"IsSucc": true,
"Message":"已经是最新版",
"Code":"new version"
}
-
错误返回数据格式
如果服务器内部错误或处理时遇见错误(访问权限,参数错误),会返回统一个错误信息,如下:
{
"IsSucc": false,
"Message":"访问未授权",
"Code":"unauthorized"
}
IsSucc: true-成功,false-失败
Message: 错误描述
Code : 错误代码 -
接口命名规则
api调用路径 http://{主机Url}:{port}/api/{API版本}/[资源]/[动作或下层资源], 特定的api路径以具体路径为准
例:获取所有的商品单位信息 http://192.168.1.24:813/api/v1/unit
修改单个商品单位信息 http://192.168.1.24:813/api/v1/{id}/{name}
**API版本根据版本向上更迭 (v1,v2,v3...)** **下面提到的URL是从** */api/* **开始**