第三方API接口测试问题反馈文档

大家在给甲方做大型项目的时候,有时候参与的厂商比较多,而公司负责的部分又需要第三方厂商提供接口支持。

例如我们做医疗行业的,给医院提供医保控费系统服务的,就需要HIS厂商提供接口给我们采集数据。有时候他们不理解你们提供的接口需求文档,所以一些数据给错了或者没给到,也可能他们接口本来就开发错了,还有一种可能就是我们的测试人员没有按照HIS的要求进行测试使用导致,这个时候就需要他们积极的协助配合。

但是呢,有些通用接口已经开发好的不一定就你们公司使用,一旦修改的话可能影响了别的系统,所以HIS厂商一般不太乐意去帮你修改,尤其是当你提出的修改需求他们都听不懂的时候,更不想费力去听你讲了。
这时候,一份详细且又规范的文档就显得特别重要,我们可以设计一个文档来尽可能详细的描述我们发现的问题,是怎样测试的时候发现的以及我们真正需要的是什么样的数据,把这份文档丢给他们,让他们一看就能马上定位问题,问题就很好解决了。

以下是我设计的关于接口测试问题向第三方厂商反馈并寻求积极配合处理的文档模版(文末提供文档下载地址):
本文档是站在第三方技术人员的角度去思考他们需要什么信息来辅助他们定位问题

  • 文档说明解释了为什么发这份文档给他们
  • 问题反馈记录汇总记录了所有可能存在问题的接口,因为有时候处理接口并不是一次性就能完善的,需要不断的协调并进行修改,文档的目的也是为了记录我们处理接口问题的过程,做留档。
  • 接口地址用于说明我们测试这个接口的时候是用了这样的url,可以让第三方技术人员判断我们是不是测错接口了。
  • 测试人员用于第三方技术人员直接于测试人员联系并做出解释。
  • 测试时间记录的测试发生的时间,方便他们查找日志文档。
  • 请求方式请求头部信息请求参数可以让第三方技术人员快速判断测试人员是否按照接口要求进行测试,此外请求猜数也方便第三方技术人员自己测试进行问题复现。
  • 响应状态码则直接告诉他们接口有没有通。
  • 实际返回值预期返回值可以让第三方技术人员进行对比我们想要得到什么样的数据。
  • 问题描述记录我们发现什么问题以及希望解决什么样的问题。


    以上是我作为一个开发着的角度设计的文档,至于有没有用那就 见仁见智了,反正我要是第三方厂商看到这种文档,我会尽可能积极配合。

每一个开发工程师都有一个共同点,那就是交卷不改,开发好的接口凭什么说改就改,且有时候一些需求的确是很过分的。
所以要想少跟开发工程师尤其是第三方的拉扯,你是不是该思考思考你的接口设计的是否合理?有些数据可以自行计算的是否应该自己去计算?有些数据在别的接口已经提供了是否可以利用起来?

另外,关于技术公司跨部门间沟通的问题,你可以阅读这篇谈“技术公司跨部门间沟通”问题及解决方案
或者是第三方API接口测试报告模版
文档模版下载:百度云盘://pan.baidu.com/s/1NZQLrCVmsZqIXgUApqvU1Q 提取码:dppj