最近做了好几个项目的接口自动化，接口测试很重要的参考依据就是接口文档，在自动化实施过程中碰到的接口文档也是千差万别，有的项目没有接口文档，有的项目有接口文档，有接口文档的项目，有的很完善，有的不完善，有的没有和项目迭代保持最新，一直也没有对文档这一块做一个总结，导致猛的说起这件事，会漏掉平时工作中的处理办法。

 

我们为什么要提这个接口文档呢，首先从开发角度，有了接口文档，各个模块之间的开发才能更清楚的知道对方的接口是如何定义和调用的，并且新入职或新接手的开发能快速的上手这个接口，具有指导意义。其次从测试角度，有了接口文档，测试才知道如何去调用，如何去传参，如何设计用例来验证结果的正确性，不然靠口口相传，一方面沟通的成本会很大，很浪费时间，另一方面不能保证在口头交流过程中漏掉一些东西，导致最终质量上出现缺陷，可见接口文档是多么的重要。

 

因为公司岗位的特殊性，我们项目目前针对接口文档是这样做的：

 

 

 

用的软件导出图片额度没了，先截图了，不清晰，大概看吧，从上面的图中可以看出，接口文档的提供具有一定的主观性，有些随意，不规范，也没有一定的约束，所以要想保证接口文档的有效性和规范性，首先应该从流程规范上面去约束，虽然google测试之道不推荐强流程和教条式的测试，但是国内目前的环境和大多技术人员的意识还没有达到像google那样的境界，没有流程规范，就不会自觉的去执行，久而久之，便会不了了之。

 

那么怎么从流程规范上面去约束呢，我目前想到的一个是评审阶段，一个是提测阶段，一个是总结报告阶段，一个是上线阶段，顺序是：

• 评审阶段

　　在设计评审和代码评审的时候，就确认接口文档是否可用，是否完善，如果不完善，需要在评审结果中指明，补充完善接口文档。

• 提测阶段

　　接口测试人员检查在提测文档中是否包含了接口文档，并检查文档的可读性以及有效性，如果没有接口文档或者可读性极差，则打回提测，待补充完善后重新提测。

• 总结报告阶段

　　测试结束后，对本次测试过程中，接口文档的规范性做一个报告，如果接口文档在提测之前没有规范，则在报告中体现出来，并@各方引起重视

• 上线阶段

　　这个阶段是产品的最终阶段，不建议立马作为一个流程环节，建议是先做好前面三个阶段的工作后，磨合期已过，各个项目已经适应了前三个阶段，并可以按时提供规范的接口文档后，该阶段再拿出来作为一个审核流程环节，就是如果上线申请中没有接口文档，则不予上线。

 

最后的阶段是我们的目标，所以我们在推广流程的前期，就要把目标给说出来，说明下最终目标的严重性，并且流程的推广一定要是职位级别从上往下传达。