对外接口开发总结

Posted 2022-08-16 chilli

我在工作中经常给其他外部系统提供接口，从最初不知从何下手，磕磕绊绊到现在能按期完成，踩坑无数。当然其中有很多是自身原因，一点开发的技巧也不懂导致的。所以总结了一些我认为有用的经验：

1.接口文档

　　一定要保留每个版本的开发文档，如果业务变更频繁，对接的业务顾问和开发人员有可能会记错，或者忘记自己曾经要求做过哪些改动。最好把业务的每次变更都记录下变更时间，变更要求提出人，变更原因。一定要自己记录下来。

接口里的一段一定要一个一个的敲定它的实际含义。业务顾问可能是外聘的专家并不熟悉对接系统的实际业务，理解会存在偏差。

2.接口日志

　　接口的第一行一定要记录下接口的接收参数。接口里逻辑处理完也要记录下改动的日志。我遇到过调错接口，坚持我提供的接口有错误的对接开发人员，他的理由是他的日志显示接收到一个错误。还好我有日志证明接口根本没被触发。他都不知道调用到哪去了还不能接收个错误？！

3.随机炸弹

　　程序员大多是一群热爱技术，敬畏技术的人。如果对接的开发人员是一个自信心膨胀，觉得自己牛叉到不行的人真的要小心再小心。