接口开发注意事项.docxVIP

接口开发注意事项 第一：接口开发的流程问题。 接口开发的大致流程： 和第三方讨论需要实现哪些接口。 重点是要确定每个接口的具体功能。 接口参数在开发过程中常常会有变动， 所以 讨论中一般不会明确定义。 编写详细设计文档。 文档包括接口名，参数名，参数类型，返回消息格式等，并提供给合作方。 编码 接口根据实际需要进行调整，同时更新详细设计文档，保持接口详细设计的可追 溯性。 测试 包括接口内部测试、修改，和第三方的联调。 上线 接口正式上线，测试通过则上线成功，失败则回退 ，并从第4步开始新一轮的测 试，直到系统上线成功。 常见问题： 详细设计文档应付了事，甚至不写设计文档。 实际的开发过程中，由于时间的原因，或者开发团队对设计文档的不重视， 造成 有的开发者忽视接口设计文档的作用，甚至不写设计文档。 设计文档的缺失，往往会造成：人员流动时，系统无法顺利交接；会给接口的升 级，带来重重困难。 不按合作双方的接口定义，私下决定不实现某些接口。 这种情况不一定每个人都会遇到， 但我确实遇到过这种事情。 某一次和一个比较 有名的体育社区的合作过程中， 由于我们的平台是类电子商务的， 所以要给用户 建立财务账户，如果我们系统中不保存用户的基本信息， 就没法为用户创建账户。 所以我方提供的接口文档中，有一个注册接口，需要用户在体育社区的注册时， 同时把信息传递到我们的平台，这样我们就会为这个