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

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

但是呢,有些通用接口已经开发好的不一定就你们公司使用,一旦修改的话可能影响了别的系统,所以HIS厂商一般不太乐意去帮你修改,尤其是当你提出的修改需求他们都听不懂的时候,更不想费力去听你讲了。

这时候,一份详细且又规范的文档就显得特别重要,我们可以设计一个文档来尽可能详细的描述我们发现的问题,是怎样测试的时候发现的以及我们真正需要的是什么样的数据,把这份文档丢给他们,让他们一看就能马上定位问题,问题就很好解决了。

以下是我设计的关于接口测试问题向第三方厂商反馈并寻求积极配合处理的文档模版(文末提供文档下载地址):

本文档是站在第三方技术人员的角度去思考他们需要什么信息来辅助他们定位问题

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





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

每一个开发工程师都有一个共同点,那就是交卷不改,开发好的接口凭什么说改就改,且有时候一些需求的确是很过分的。

所以要想少跟开发工程师尤其是第三方的拉扯,你是不是该思考思考你的接口设计的是否合理?有些数据可以自行计算的是否应该自己去计算?有些数据在别的接口已经提供了是否可以利用起来?

另外,关于技术公司跨部门间沟通的问题,你可以阅读这篇谈“技术公司跨部门间沟通”问题及解决方案

或者是第三方API接口测试报告模版

文档模版下载:百度云盘:https://pan.baidu.com/s/1NZQLrCVmsZqIXgUApqvU1Q 提取码:dppj

第三方API接口测试问题反馈文档的更多相关文章

  1. Web Api 自动生成帮助文档

    Web Api 自动生成帮助文档   新建Web Api项目之后,会在首页有API的导航菜单,点击即可看到API帮助文档,不过很遗憾,Description 是没有内容的. 怎么办呢? 第一步: 如果 ...

  2. Web API 自动生成帮助文档并使用Web API Test Client 测试

    之前在项目中有用到webapi对外提供接口,发现在项目中有根据webapi的方法和注释自动生成帮助文档,还可以测试webapi方法,功能很是强大,现拿出来与大家分享一下. 先看一下生成的webapi文 ...

  3. hadoop2.6.0汇总:新增功能最新编译 32位、64位安装、源码包、API下载及部署文档

    相关内容: hadoop2.5.2汇总:新增功能最新编译 32位.64位安装.源码包.API.eclipse插件下载Hadoop2.5 Eclipse插件制作.连接集群视频.及hadoop-eclip ...

  4. 【奇淫技巧】API接口字段table文档转代码工具

    今天做一个视频接口对接,发现对方提供的文档没有json格式,无法自动生成请求和响应对象 json自动生成C#类的工具 http://tool.sufeinet.com/Creater/JsonClas ...

  5. rest api方式实现对文档库的管理

    写在前面 刚入职一家新公司,在对接app的时候需要获取到某公司的sharepoint上面的文档库,获取文档库列表,团队文档库中的文件和文件夹列表,个人文档库中的文件文件夹列表,及在app端进入文件夹的 ...

  6. Web API 自动生成接口文档

    1.添加NuGet程序包 Microsoft ASP.NET Web API 2.2 Help Page      (这是微软官方的) A Simple Test Client for ASP.NET ...

  7. NET 5.0 Swagger API 自动生成MarkDown文档

    目录 1.SwaggerDoc引用 主要接口 接口实现 2.Startup配置 注册SwaggerDoc服务 注册Swagger服务 引用Swagger中间件 3.生成MarkDown 4.生成示例 ...

  8. 12- APP接口测试以及接口文档的分析

    什么是接口? 为什么要做接口测试? 接口测试流程 需求评审 需求分析 接口用例设计 执行测试用例 bug的定位于追踪 接口文档分析 接口文档分析:开发 内容: 1.接口名称 2.接口地址 3.支持方式 ...

  9. Asp.Net Core Api 使用Swagger管理文档教程的安装与使用

    这周因为公司的需求需要我做一个Api的程序,这周的三天时间我一直在Core Api和 framework Api之间做纠结.不知道要使用哪一个去做项目,想着想着就决定了.既然两个我都没用过那个何不来使 ...

随机推荐

  1. 被收费绘图工具 PUA 了怎么办?来看看这个老实工具吧

    本文非常适合 Electron 入门选手,墙裂推荐! 本文作者:HelloGitHub-蔡文心 大家好!这里是 HelloGitHub 推出的<讲解开源项目>系列,今天给大家带来的一款基于 ...

  2. Docker文件挂载总结

    Docker容器启动的时候,如果要挂载宿主机的一个目录,可以用-v参数指定. 譬如我要启动一个centos容器,宿主机的/test目录挂载到容器的/soft目录,可通过以下方式指定: # docker ...

  3. 2018大都会赛 A Fruit Ninja【随机数】

    题目链接:戳这里 题意:一个平面里有n个点,问存不存在一条直线上有m个点,满足m >= n*x. 解题思路:0<x<1,且x小数点后只有1位,也就是说10*m > n.假设存在 ...

  4. Leetcode(28)-实现strStr()

    实现 strStr() 函数. 给定一个 haystack 字符串和一个 needle 字符串,在 haystack 字符串中找出 needle 字符串出现的第一个位置 (从0开始).如果不存在,则返 ...

  5. mimikatz+procdump 提取 Windows 明文密码

    0x00 原理 获取到内存文件 lsass.exe 进程 (它用于本地安全和登陆策略) 中存储的明文登录密码. 0x01 操作 Windows10/2012 以下的版本:1.上传 procdump 执 ...

  6. for-in循环等

    一.for-in循环 in表示从(字符串.序列等)中一次取值,又称为遍历 其便利对象必须是可迭代对象 语法结构: for 自定义的变量 in 可迭代对象: 循环体 for item in 'Pytho ...

  7. h5py/__init__.py:36: FutureWarning: Conversion of the second argument of issubdtype from `float` to `np.floating` is deprecated

    Reference 问题 ... h5py/__init__.py:36: FutureWarning: Conversion of the second argument of issubdtype ...

  8. vue-cli & webpack & vue.config.js

    vue-cli & webpack & vue.config.js configureWebpack // vue.config.js module.exports = { confi ...

  9. algorithm & bitwise operation & the best leetcode solutions

    algorithm & bitwise operation & the best leetcode solutions leetcode 136 single-number the b ...

  10. convert image to base64 in javascript

    convert image to base64 in javascript "use strict"; /** * * @author xgqfrms * @license MIT ...