RobotFrameWork接口設計規範

1. 前言

    繼前面一章《RobotFramework環境搭建》介紹了在本地如何將接口自動化實施過程所須要的基礎環境搭建好，在這裏假設你們都已經知道環境如何搭建了，若是不清楚的可直接查看上一章節 RobotFrameWork環境搭建（基於HTTP協議的接口自動化），那麼環境一切ready了，是否是表明就能夠開幹了呢？

    不急，對於一個team在開展這類大工程的時候，要考慮到團隊多人協做，如何讓本身的東西，別人能更快看懂上手，如何讓你們風格保持統一，這裏就還須要在真正開始以前，制定一些針對團隊達到統一共識的約定或者規範。就比如我相信任何一個較成熟的研發團隊，都會有本身內部的一套編碼規範如：Java編碼規範、Python編碼規範、JavaScript編碼規範等。

    那麼接口在開始以前，你以爲須要有哪些規範呢？下面我就介紹一下之前我在公司開展接口項目時，制定的一些針對接口項目的約定規範。（固然不一樣公司能夠根據公司文化、項目差別自行制定，不必定咱們的就是最好的，找到一套適合本身的纔是關鍵）

  

2. 規則細分

 

    那對於開展接口自動化來說，有哪些地方規範須要注意呢，這裏我分幾部分進行介紹：

    

目錄結構規則 -> 接口命名規則->用例命名規則->用例分類規則->用例編寫規則->公共方法命名規則

 

3. 規則說明

 

3.一、用例目錄結構規則

 

  好的目錄結構可讓項目呈現一目瞭然，假如公司統一採起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.二、接口命名規則

自動化腳本中接口命名一般能夠按照接口部分url+接口方法類型組成，部分url是指非參數部分的最後兩級路徑。Http接口方法類型主要分爲：get、post等，例如：

/json/v2/cdn/user/getUserInfo 接口命名爲: user_getUserInfo_get

/json/v2/user/getUserInfo 接口命名爲：user_getUserInfo_post

 

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.四、用例分類規則

用例會隨着不斷的接口迭代愈來愈多，並且有時在跑接口巡檢時，也會隨着測試範圍的不一樣，而但願選取不一樣的測試集下的用例來運行。

因此最好的方式是在在設計之初的階段就要考慮好用例的分類，而在RobotFramework中經過標籤Tag的形式，很方便就能夠將用例劃分紅不一樣歸類。

那麼最經常使用的用例分類原則，有3類：

第1類，按照環境劃分：按筆者經驗，能夠分紅四類不一樣運行環境的用例，如：online-線上環境、test-測試環境、general-預發佈環境、develop-開發環境；

第2類，按用例編寫者來劃分：如這條用例是張三編寫的仍是李四編寫的，因此須要增長用例所屬者的標籤，如zhangsan；

第3類，按照特性標籤來劃分：特性標籤可由使用用途來自行定義，根據特殊場景來定義，好比每日巡檢若是跑主流程的核心接口，則能夠增長main標籤表明此條用例是核心接口用例。

 

 

3.五、用例編寫規範

a. 公共方法類和公共用例的腳本，須要每句註解其做用；

b. 接口定義方面須要有屬於如個版本需求、用途。如用接口有修改須要增長修改緣由和版本及其用途記錄；

c. 測試用例對業務用例須要註解其驗證點，其它類型可自行要求。

d. 接口請求公共字段放在公共方法中

 

3.六、公共方法

接口項目用到的公共方法須要單獨抽離到公共庫層，不能和用例層混在一塊兒，能夠根據應用產品及方法做用來命名，當各產品項目都適用可不帶產品名稱直接用方法來命名，如：

mobile_show_post: 表示直播看模塊的post請求公共方法

md5_encode: 表示md5加解密方法

 

4. 教程目錄大綱（已更新）

RobotFrameWork系列免費課程大綱介紹

RobotFrameWork環境搭建（基於HTTP協議的接口自動化）

 

5. 下節預告

《RobotFramework接口項目分層和通用控制方式》

 

 

更加詳細可見：  原文連接