API接口规范V1.0——制定好规范,才好合作开发

2021-08-02 00:55

阅读:591

标签:src   blog   添加   返回   参数   add   bsp   null   示例   返回码规范: 统一六位 000000 表示成功! 参数相关返回码预留100000-199999;系统相关返回码预留200000-299999;数据中心310000-319999后续项目以此类推,后续根据业务扩展情况新增操作码需要提前备案! module = 系统码  optCode = 操作码  optDesc = 操作描述  resultCode = 结果码  resultDesc = 结果描述  bizCode = 业务码  data = 返回数据 业务码 = 系统码- + 操作码- + 结果码   业务码内容与之前定义的保持一致,实例:TaoBao- + Order_ADD- + 330002 返回结果示例如下所示: 异常返回: { "optCode": "STORE_ADDMSG", "optDesc": "库管中心新增消息", "resultCode": "330002", "resultDesc": "库管中心新增消息失败,添加消息到搜索引擎库异常", "data": "", "module": "HME", "bizCode": "TaoBao-Order_ADD-330002", "success": false } 正常返回: { "optCode": "STORE_ADDMSG", "optDesc": "库管中心新增消息", "resultCode": "000000", "resultDesc": "操作成功", "data": "", "module": "HME", "success": true, "bizCode": "Tao-Order_ADD-000000" } API文档规范: 接口名称: products.search 接口描述: 中医药产品接口调用查询 请求参数: 响应参数: JSON返回示例: { "optCode": "STORE_ADDMSG", "optDesc": "数据中心新增消息", "resultCode": "000000", "resultDesc": "操作成功", "data": "[ { "keywords": null, "tymc": "阿莫西林", "tyjx": "颗粒剂", "projectId": "44AFC2328D63A53EE05012AC241E3E1B", }]", "module": "HME", "success": true, "bizCode": "HME-STORE_ADDMSG-000000" } 服务码参照: 结果码参照: API接口规范V1.0——制定好规范,才好合作开发标签:src   blog   添加   返回   参数   add   bsp   null   示例   原文地址:http://www.cnblogs.com/Javame/p/7509745.html


评论


亲,登录后才可以留言!