RobotFrameWork接口设计规范

测试开发技术

发布于 2020-01-17 17:05:15

7550

发布于 2020-01-17 17:05:15

文章被收录于专栏：测试开发技术测试开发技术

点击上面微信号关注我

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；