前后端交互 从测试角度理解 接口设计

原文链接: 前后端交互-一些关于接口设计的思考

作者：安东尼_Anthony

浏览自:

CameloeAnthony

想要做好软件测试 就要深刻理解前后端交互 从接口层面理解产品

前言

最近在工作中和后端童鞋打交道，前后端沟通最为重点的就是接口API,这里整理一下接口设计的一些考虑点并做分析，希望对大家有帮助 。

兵马未动，粮草先行。在一款APP产品的各个版本迭代中，兵马的启动指的是真正开始敲代码的时候，粮草先行则是指前期的需求，交互，UI等评审准备阶段，还有本文要说的接口的设计与评审。虽然很多时候一个api接口的业务，数据逻辑是后端提供的，但真正使用这个接口的是客户端，一个前端功能的实现流程与逻辑，有时候只有客户端的RD才清楚，从某种意义来说，客户端算是接口的需求方。

所以建议在前期接口设计和评审时，客户端的RD应该更多的思考和参与，什么时机调什么接口？每个接口需要哪些字段？数据含义怎么给？只有这些都考虑清楚，且达成一致并产出接口文档后，当项目真正启动时，根据接口协议进行开发，才能尽量避免各种不确定因素对项目整体进度的影响。

接口设计的考虑点

我从下面几个方面考虑接口的设计：

• 1 接口文档

• 2 接口安全

• 3 一些基本原则

• 4 瘦客户端

---

1 关于接口文档

1.1 接口设计必须提供接口文档

无论项目团队的大小，在遇到接口问题的时候单纯的从代码出发，而不是从接口文档出发，对于整个项目团队的维护简直就是耍流氓。

1.2 文档也应纳入版本控制

使用markdown,wiki 做文本类型的文档，使用svn，git等做为版本工具 可以很清晰的看到接口文档的改动人和改动时间，同样是方便维护工作。

1.3 文档类型选择markdown,wiki等

使用文本类型的文档（比如markdown, wiki等格式），一则方便比较版本间改动，二则可以生成html, word, pdf等多种美观格式。我见过有好多团队是使用word来写文档的，由于是二进制格式，不利于版本比较，也不专业。

1.4 文档- 简洁

档不应浮于形式，而是力求只写最有价值的内容。做好这一点的关键是作者与读者要有足够的约定，比如蚕茧法就能很好的帮助简化类型定义的描述。

1.5 应有机制保证接口文档与