WebApi App 项目接口总结

项目经验总结(一)如何约定接口的定义

      最近项目终于上线了，上线当天还算正常，没出啥大问题，希望以后继续保持，哈哈，上线前一阵工作特别累，最近脑袋都有点晕，工作累并不是因为工作量大，而 是有一些其它主观上的原因。这里我想总结下工作累的原因。我会分几篇来总结，这篇我先来讲讲和其它小组合作开发项目时，如何约定服务接口。

      说到服务接口的约定，大家听起来可能会认为没啥好说的，无非就是服务端提供数据，客户端调用，但往往是简单的事情容易出错。

     1： 服务的接口最好由客户端及服务端共同定义：服务端的数据是给客户端用，但最好是客户端明确的告诉服务端需要哪些数据，我们可以详细到传入的参 数，返回的对象的所有属性内容及详细描述。我们这次开发时，这些数据均是服务端来定义，这样的结果就是，给出的数据有的不完全满足客户端需求，有的给出了 客户端可能根本用不上。所以在后期的开发中，经常是客户端开发到一定程度，发现还有数据无法获取，这时又需要找服务端商量如果处理，这一来一去的，导致接 口相当不稳定，对双方的时间都是一种考验。       由客户端来约定服务接口的另外一个好处：当服务端没有提供真正的接口时，我们可以自己定义的接口内容，编写一个假的接口，当真正的服务开发完成后，客户端 只需要修改服务层的调用方式即可，大大减少了和服务端的依赖。接口数据结构的定义，如果有客户端参与，那么在开发时，就会针对返回对象的数据意义非常清楚。

     2：  约定服务接口内容的同时，一定不要忘记还是约定服务接口的提交时间，因为服务接口的开发质量以及进度直接影响客户端的开发质量以及进度。由于本次开发过程 中，我们两个开发对业务逻辑都有一定的陌生，导致接口的开发出现了延时，这也直接影响了项目的正常提交以及测试环节，由于缺少接口联调时间(接口联调时间 就是指测试接口返回数据的正确性的时间)，导致项目提交测试部门测试时，出现很多低级错误。