接口测试规范

严禁转载!
最近整理的接口测试规范,待改进中。

目标

为了确保软件的功能符合业务或用户的需求,把尽可能多的问题在发布或交付之前发现并改正,确保数据服务开发的质量。

测试任务要求

开发提交测试任务:

  • 需要在每个需求的正式系统测试前,预测试(冒烟测试)通过;
  • 涉及鉴权、计费或白名单的接口,需要配置好;

测试内容

测试基本流程

步骤描述:根据具体情况完成各项操作

| 测试准备 |

  • 需求分析、需求评审,分析业务的需求可行性。
  • 完成编写测试计划和测试用例
  • 测试计划、用例评审

| 测试过程 |

  • 测试数据准备
  • 执行脚本,测试环境打包
  • 执行测试用例
  • 提交缺陷并跟踪缺陷至验证通过
  • 完成回归测试
  • 编写测试报告

| 上线准备 |

  • 验证鉴权和计费
  • 验证生产环境账户是否有对应的表权限
  • 接口是否有熔断配置;
  • 执行sql记录查询时间,超过预期指标(目前预期指标为3s内)需要联系开发优化,并跟进直至优化达到预期目标。
  • 检查接口管理系统,接口信息是否已维护

| 生产测试 |

  • 测试基础功能
  • 维护接口管理系统信息,例如:接口状态改为:生产
  • 关注性能,例如接口响应时间;

| 生产跟踪 |

  • 持续关注接口性能情况;
  • 持续关注线上监控报警邮件;

API测试内容

URL规范

1、 针对公司整体业务和需求,拟定三大类url格式,在服务对接客户时 进行筛选填充

  • 规范管理url地址
  • url地址含义可读
  • 产品编码确认
    2、产品命名 :符合公司具体的标准要求
    3、特殊命名,特殊业务的url命名

发送信息

  • 获取资源,使用 GET 方式;
  • 新增、修改、删除、查询资源,使用 POST 方式

| 请求头 |

  • 采用 RESTful 风格
  • 请求头内容包括: Content-Type=application/json、
    Authorization (授权码)

| body内容|
基础要求
参数校验
正常的入参:

  • 根据接口设计文档的入参标准,输入正常的参数,参数名需要符合标准命名;
  • 请求体使用 JSON格式,命名格式小驼峰;
  • 是否分页,例如:除仅查询记录一条的情况外,均需做分页处理(有特例再讨论),分页数量1000;
  • 时间格式(一般为yyyy-mm-dd hh24:mi:ss);

参数异常:

  • 参数为空
  • 多参或少参
  • 错误的参数

数据异常:

  • 数据类型错误
  • 非空参数为空
  • 长度不符合设计
  • 不在字典范围内的数据
  • 不合法的成员
  • 特殊字符和敏感字符
  • 存在关联关系的参数数据异常等
{
 "lastupdateddtStart": "2020-09-03 09:56:33",
 "lastupdateddtEnd": "2020-09-20 09:56:33",
 "start": 1,
 "end": 1000
}

响应信息

| 响应头 |

  • 命名方式为小驼峰
  • 返回基础格式固定
  • 响应码(具体查看后面的响应码图)

| 响应内容 |

正常的输出参数:

  • 命名方式小驼峰;
  • 参数名是否符合数据接口清单标准命名;是否和数据库查询结果一致;
  • pageCount是否无误(确认是否需要计算总数);
  • 时间格式(一般为yyyy-mm-dd hh24:mi:ss);
{
    "statusCode": 200,
    "msg": "",
    "pageCount": null,
    "reqData": {
        "dataList": []
    }
  }

输出处理检查:

  • 返回的数据需要有两条以上记录(只能查询到一条结果的情况除外);
  • 服务期限:检查数据时限范围是否满足数据接口清单文档要求,例如三个月、两个月等;
  • 分页数据是否重复;
  • 接口定义返回的错误码是否合理
  • 提示是否友好,是否出现敏感信息等
  • 响应耗时,是否有添加熔断配置。超时处理不当,可能会引起进程阻塞。

| 响应格式 |

  • 一般默认选择json格式查看
  • 选择HTML或TEXT、XML格式,检测显示是否无误

响应码,例如:
200 :成功
202 :数据错误
400 :语义有误
403 :无权限
404 :资源不存在
415 :调用内部接口错误
429 :访问次数过多
500 :未知错误

设计用例分析

| 性能测试 |

  • 并发测试:仅成功一条数据,不会出现多条重复数据。
  • 负载测试:大数据量测试的情况下功能是否正常,接口响应速度是否符合预期标准;

| 接口处理逻辑 |
数据库操作:

  • 对数据库操作是否频繁,写库完成后进程是否释放,
  • 业务数据入库是否正常,插入数据需要考虑失败时的处理是否合理,是否会出现重复数据入库,是否出现乱码;日志数据入库是否正常。
  • 数据更新是否正常,尤其是时间类字段,时间是否为24小时制的格式。异步操作更新数据库同个表信息时,是否会导致锁表,特别是两个操作时间相近的情况下。
  • 数据删除、备份是否正常。物理删除/逻辑删除
  • 接口查询数据,输出内容是否和数据库查询结果一致

需调外部接口:

  • 异常情况需考虑:存储处理、日志监控;

需推送信息接口

  • 需要考虑推送失败的处理;
  • 是否可以多次推送或者去重规则;

复杂的处理逻辑:

  • 时序分析:复杂的系统中,是由一系列的接口按照指定顺序进行,这些接口形成一个业务流程,只有按照顺序依次执行,才能得到预期的结果,考虑在执行过程中发生其他的分支动作,程序应该怎么处理。
  • 状态转换的分析:状态之间的切换是否正常;需要考虑如果没有按照正常业务流程进行操作,状态显示是否可控,是否会出现异常状态,具体怎么处理。

| 考虑历史版本的兼容性 |
与历史版本的兼容性分析:

  • 是否在某种特定情况下会触发历史版本的接口,导致调用出现意想不到的问题。例如已废弃的类名或接口,代码并未注释。
  • 涉及同一个系统,新接口是否受历史接口的影响,尤其是新旧接口都对同一个功能进行处理,是否存在业务不兼容的问题

| 特殊业务 |
具体参照自己公司的业务内容

| 接口设计 |
接口设计是否合理:

  • 接口定义字段是否满足所有调用者的需求。例如:涉及前端联调,需先确认好接口定义字段是否满足前端页面要求。
  • 接口调用是否方便,是否可扩展。例如:可以增加表来存储转换数据信息,减少使用代码。
  • 接口的参数使用是否方便,是否存在歧义。例如参数,当用来“仅查询”使用‘0’,“删除”使用‘1’。

缺陷管理

缺陷应该具备以下属性:
属性名称: 描述
缺陷状态: 缺陷等级:缺陷引起的故障严重程度
缺陷标识: 产品号,缺陷的标识信息
系统名称: 缺陷所属的模块,例如接口服务
重现步骤: 详细的缺陷重现操作步骤
缺陷内容: 提供出现缺陷的信息,例如:请求信息、报错信息等,方便开发排查问题
附件 : 与缺陷相关的附件,例如截图、文档等
优先级 : 缺陷需要修复的紧急程度
环境 : 明确缺陷产生的环境是测试环境还是生产环境
修复人 : 确定需修复该缺陷的开发人员
备注 : 对缺陷的其他描述

测试方法

使用黑盒测试方法,例如边界值测试、等价类划分法、错误推测法、因果图法等
测试工具:使用postman、jmeter等工具。

完成准则

  • 对所有案例的通过率达到99%。
  • 确保覆盖所有路径。
  • 确保所有接口工作正常。
  • 执行测试的结果要跟踪、评审。

附录

测试任务依据

测试人员必须真正弄懂需求和详细设计才能更好的完成测试工作,需要获得的相关资料的地址:

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
禁止转载,如需转载请通过简信或评论联系作者。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,015评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,262评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,727评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,986评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,363评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,610评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,871评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,582评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,297评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,551评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,053评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,385评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,035评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,079评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,841评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,648评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,550评论 2 270

推荐阅读更多精彩内容