接口开发规范.docx

合商云购接口开发规范验签Model迭代规范说明：现在接口版本的验签规则为：版本号+APPNAME+Model（序列化）后MD5加密，加密后与请求传递的验签串匹配，验签串相同后才会执行接口方法。问题：如果接口方增加或者减少验签Model，调用方没有对应修改，验签失败导致程序崩溃。解决：相关验签的Model包括请求和返回，任何人不允许随意修改，如果需要修改，向项目负责人提出修改申请，写明申请日志，格式如下；Api名称接口名称Model名称修改字段类型修改方式说明申请人接口版本申请时间UserApiUserLoginUserLoginReqUserBankNoString增加移动端登录后会根据是否设置银行卡跳转页面浪人V1.02017年4月17日 11:57:37版本迭代问题：验签Model，必须标明注释，包含创建人、创建时间、版本，如下图。验签Model迭代版本为了对历史版本的支持只允许增加字段、不允许删除和修改字段。接口文档版本更新接口版本迭代规范说明：在不影响历史版本正常使用的前提下，保证迭代版本更新。新的版本接口应考虑历史版本支持。问题：直接修改版本导致线上历史版本调用错误，从而导致程序崩溃，影响比较直接的为手机端。手机端发版肯定会有多个历史版本同时在线上使用，出现此问题会导致一部分用户手机端软件打不开或者崩溃。解决：1.正常情况下只允许版本增加传入参数，并对历史版本参数兼容性考虑。2.参数类型有变化重载方法。3.如业务需求改变，不可更改方法名和参数，考虑新接口开发。GET方法：迭代版本增加参数设置可为空。V1.0 版本获取商品列表GetProductList(string CategoryCode，int PageIndex,Int PageSize) V2.0 版本GetProductList(string CategoryCode，int PageIndex,Int PageSize,string UserId=””)2.0版本因业务需求增加UserId参数，设置可为空定义，1.0版本即使不传入UserId也会正常进入执行接口。POST方法:同一，验签Model。版本更新对应的验签Model字段只可增加不可删除和修改。并对增加字段标注版本号、开发人、最好注明因何原因或业务需求增加此字段。调用方做对应增加字段调整，历史版本不使用增加字段，设置为空或默认值，接口开发方做响应处理。接口名定义和接口文档对应规范接口方法规范定义：对接口方法各版本迭代做注释包括版本号、开发人、方法名和输入参数，如下：接口文档更新接口文档及时更新，正确按照要求填写接口文档。时间：2017-4-17 14:49:15文档版本：V1.0浪人