RobotFrameWork接口设计规范
1. 前言
继前面一章《RobotFramework环境搭建》介绍了在本地如何将接口自动化实施过程所需要的基础环境搭建好,在这里假设大家都已经知道环境如何搭建了,如果不清楚的可直接查看上一章节 RobotFrameWork环境搭建(基于HTTP协议的接口自动化),那么环境一切ready了,是不是代表就可以开干了呢?
不急,对于一个team在开展这类大工程的时候,要考虑到团队多人协作,如何让自己的东西,别人能更快看懂上手,如何让大家风格保持统一,这里就还需要在真正开始之前,制定一些针对团队达到统一共识的约定或者规范。就好比我相信任何一个较成熟的研发团队,都会有自己内部的一套编码规范如:Java编码规范、Python编码规范、JavaScript编码规范等。
那么接口在开始之前,你觉得需要有哪些规范呢?下面我就介绍一下以前我在公司开展接口项目时,制定的一些针对接口项目的约定规范。(当然不同公司可以根据公司文化、项目差异自行制定,不一定我们的就是最好的,找到一套适合自己的才是关键)
2. 规则细分
那对于开展接口自动化来讲,有哪些地方规范需要注意呢,这里我分几部分进行介绍:
目录结构规则 -> 接口命名规则->用例命名规则->用例分类规则->用例编写规则->公共方法命名规则
3. 规则说明
3.1、用例目录结构规则
好的目录结构可以让项目呈现一目了然,假如公司统一采取git仓库来管理各项目的接口,这里假定git仓库地为:git@xx.xx.xx.xx:xx/robotframework-interface-cn.git,那各个业务项目组可以通过不同分支的形式来管理各业务接口,如公司某产品通过业务线分为移动端业务线和web网站业务线,那么可为两个业务线开各自独立分支如develop-mobile、develop-web,至于详细的代码管理形式,后面再另开一章节来介绍,再此就不再过多的说明了。
另一方面通过好的目录结构可以很好的区分开各接口归类,建议最多3层目录层级,比如一个直播混合app,那么第1层目录可以按模块调用方划分,比如Mobile_Show(直播看模块)、Mobile_Sing(直播听模块)、H5_Mobile(H5页面调用的接口)、Mobile_Socket(前端调用socket协议的接口)。
第2,3层目录主要按产品应用模块来划分或者根据接口url的路径来划分,比如: mobileshow/json/v2/cdn/mv/supportStatus接口可划分到Mobile_Show目录的子目录MV下。
3.2、接口命名规则
自动化脚本中接口命名通常可以按照接口部分url+接口方法类型组成,部分url是指非参数部分的最后两级路径。Http接口方法类型主要分为:get、post等,例如:
/json/v2/cdn/user/getUserInfo 接口命名为: user_getUserInfo_get
/json/v2/user/getUserInfo 接口命名为:user_getUserInfo_post
3.3、用例命名规则
用例命名主要为了区分用例验证点和用例作用,这里建议可以按照以下4种:
Class_序号:表示常规经典值用例,可以理解为最常用的数据,按照等价类的原则,此处每组用例所需要达到的作用应该是一致的,序号当存在多条用例的时候使用,用两位数值,如:Class_01,Class_02;
Field_序号_结果:表示字段校验用例,序号由2位数字组成,2位数字表示字段验证序号,结果通常可以分为三类,当有错误码时为错误码,当无错误码返回为空时为Null,当有数据返回时为data,例如:
返回错误码:Field_01_1100018;
返回空:Field_02_null;
返回数据:Field_05_data;
Business_序号:表示业务用例,主要用例验证业务逻辑,序号由2位数字组成,表示验证序号,如:Business_01,Business_02,Business_03;
Safe_序号:表示此用例验证安全方面,序号由2位数字组成,表示字段验证序号,如:Safe _01,Safe _02,Safe _03;
3.4、用例分类规则
用例会随着不断的接口迭代越来越多,而且有时在跑接口巡检时,也会随着测试范围的不同,而希望选取不同的测试集下的用例来运行。
所以最好的方式是在在设计之初的阶段就要考虑好用例的分类,而在RobotFramework中通过标签Tag的形式,很方便就可以将用例划分成不同归类。
那么最常用的用例分类原则,有3类:
第1类,按照环境划分:按笔者经验,可以分成四类不同运行环境的用例,如:online-线上环境、test-测试环境、general-预发布环境、develop-开发环境;
第2类,按用例编写者来划分:如这条用例是张三编写的还是李四编写的,所以需要增加用例所属者的标签,如zhangsan;
第3类,按照特性标签来划分:特性标签可由使用用途来自行定义,根据特殊场景来定义,比如每日巡检如果跑主流程的核心接口,则可以增加main标签代表此条用例是核心接口用例。
3.5、用例编写规范
a. 公共方法类和公共用例的脚本,需要每句注解其作用;
b. 接口定义方面需要有属于如个版本需求、用途。如用接口有修改需要增加修改原因和版本及其用途记录;
c. 测试用例对业务用例需要注解其验证点,其它类型可自行要求。
d. 接口请求公共字段放在公共方法中
3.6、公共方法
接口项目用到的公共方法需要单独抽离到公共库层,不能和用例层混在一起,可以根据应用产品及方法作用来命名,当各产品项目都适用可不带产品名称直接用方法来命名,如:
mobile_show_post: 表示直播看模块的post请求公共方法
md5_encode: 表示md5加解密方法
4. 教程目录大纲(已更新)
RobotFrameWork环境搭建(基于HTTP协议的接口自动化)
5. 下节预告
《RobotFramework接口项目分层和通用控制方式》
更加详细可见: 原文链接
RobotFrameWork接口设计规范的更多相关文章
- RobotFrameWork接口项目分层及通用控制方式
1. 前言 上一篇文章介绍了在设计接口用例之前应遵守的设计规范,详见<RobotFramework接口设计规范>,当然读者公司的内部规范也不一定非得完全遵循笔者所提到的,适合自己公司内部的 ...
- RobotFrameWork接口报文测试-----(三)demo的加强版(数据驱动测试)
在上一篇RobotFrameWork接口报文测试-----(二)demo的升级版基础上,将接口的xml的格式保存在xml文件中,然后程序如果增加一个接口,在xml文件里添加即可,无需修改自动化测试里的 ...
- API 接口设计规范
概述 这篇文章分享 API 接口设计规范,目的是提供给研发人员做参考. 规范是死的,人是活的,希望自己定的规范,不要被打脸. 路由命名规范 动作 前缀 备注 获取 get get{XXX} 获取 ge ...
- RobotFrameWork接口报文测试-----(二)demo的升级版
在上一篇,简单的demo实现了讲xml的数据发送服务器端并取得recvi_buf,然后进行了简单的解析的操作.现在就要解决之前提过的2个问题: 1. 步骤这么多,难道每写一个脚本都要重复一次么? 2. ...
- RobotFrameWork接口报文测试-----(一)简单demo的实现
最近几个月的工作任务都是通过使用RF工具来搭建服务器端接口的自动化测试,使用python作为2次开发的语言,也是第一次去做这种项目,经验善浅,还是很有可能会走很多的弯路,为此,我希望自己能把每个阶段的 ...
- robotframework接口之上传图片
python-requests及robotframework-RequestsLibrary实现multipart/form-data接口上传文件. 如Fiddle抓包截图: 实现如截图: 不要自己在 ...
- restful接口设计规范总结
这篇 文章主要是借鉴他人,但是自己很想总结出一套规范,以供向我这样的新手使用,用来规范代码,如果有什么好的提议,请不吝赐教,本篇文章长期更新! 一.重要概念: REST,即Representation ...
- REST接口设计规范总结
简介 Representational State Transfer 简称 REST 描述了一个架构样式的网络系统.REST 指的是一组架构约束条件和原则.满足这些约束条件和原则的应用程序或设计就是 ...
- REST接口设计规范
URI格式规范 URI(Uniform Resource Identifiers) 统一资源标示符 URL(Uniform Resource Locator) 统一资源定位符 URI的格式定义如下: ...
随机推荐
- fastAdmin进阶
基本知识流程一栏链接 bootstrapTable fastadmin系统配置(符内置规则): fastadmin默认的controller已实现的方法 一张图解析fastadmin的表格: fast ...
- P2280 [HNOI2003]激光炸弹(二维前缀和)
题目描述 一种新型的激光炸弹,可以摧毁一个边长为R的正方形内的所有的目标.现在地图上有n(n≤10000)个目标,用整数xi,yi(0≤xi,yi≤5000)表示目标在地图上的位置,每个目标都有一个价 ...
- Beautifulsoup关于find的测试
from bs4 import BeautifulSoup import requests url='https://book.douban.com/subject_search?search_tex ...
- 使用open live writer客户端写博客zz
下载地址 http://openlivewriter.org/ 具体配置步骤 选择日志服务类型为"其它日志类型" 添加日志账户: 安装后的优化配置 获取博客园主题 安装完OLW(o ...
- Django路由详解
一.路由基础 1.路由url函数:路由自上而下进行匹配:url(正则路径,视图函数内存地址,默认参数,路由别名) 2.路由正则: 规定开始:^ | 规定结束:$ #url(r'index', view ...
- JS运算符问题
以下代码是否报错,如果不报错输出什么,为什么 var x = !!"Hello" + (!"world", !!"from here!!") ...
- BZOJ.3218.a + b Problem(最小割ISAP 可持久化线段树优化建图)
BZOJ UOJ 首先不考虑奇怪方格的限制,就是类似最大权闭合子图一样建图. 对于奇怪方格的影响,显然可以建一条边\((i\to x,p_i)\),然后由\(x\)向\(1\sim i-1\)中权值在 ...
- Java并发编程(一)-- 多线程的基本概念
多线程发展进程 在过去单CPU时代,单任务在一个时间点只能执行单一程序:发展到多任务阶段,计算机能在同一时间点并行执行多任务或多进程--虽然并不是真正意义上的“同一时间点”,而是多个任务或进程共享一个 ...
- JavaScript基础笔记(十二)Ajax
Ajax 一.XMLHttpRequest对象 一)XHR用法 var xhr = new XMLHttpRequest(); //open()方法,参数一:发送方法,参数二:请求的URL,参数三:是 ...
- go channel tips
一.只有一个goroutine时,读写阻塞的chan会出错(“fatal error: all goroutines are asleep - deadlock!”).包括未make的chan(cha ...