軟體測試/測試開發丨如何高效使用 Requests 做接口自動化測試

公衆号搜尋：TestingStudio 霍格沃茲測試開發的幹貨都很硬核

Requests是一個優雅而簡單的python HTTP庫，其實python内置了用于通路網絡的資源子產品，比如urllib，但是它不如requests簡單，優雅，而且缺少許多實用功能。接下來的接口測試的學習和實戰，都與requests庫息息相關。

Requests官方文檔：

2.python-requests.org/en/master/ 接下來就會使用最流行的requests進行接口測試

接口請求構造

requests提供了幾乎所有的HTTP請求構造方法，以及通過傳入參數的方法，對發送的請求進行定制化的配置。可以用來應對各種不同的請求場景。

安裝 requests

pip指令安裝requests。

pip install requests           

發送get請求

import requestsr = requests.get('https://api.github.com/events')           

在請求中添加data參數，并發送post請求

import requestsr = requests.post('http://httpbin.org/post', data = {'key':'value'})           

在請求中添加data參數，并發送put請求

import requestsr = requests.put('http://httpbin.org/put', data = {'key':'value'})           

發送delete請求

import requestsr = requests.delete('http://httpbin.org/delete')           

發送head請求

mport requestsr = requests.head('http://httpbin.org/get')           

發送options請求

import requestsr = requests.options('http://httpbin.org/get')           

也可以直接使用request函數，傳入不同的method，例如使用這個方法發送get請求

import requestsrequests.request("get", "http://www.baidu.com")           

其他重要參數

下面的參數都是非必須參數，但是如果需要對請求做額外的定制化，則需要以下這些參數的作用。

• header參數，通過傳入dict定制請求頭

import requests
url = 'https://api.github.com/some/endpoint'
headers = {'user-agent': 'my-app/0.0.1'}
r = requests.get(url, headers=headers)           

• data參數發送編碼為表單形式的資料單

>>> payload = {'key1': 'value1', 'key2': 'value2'}
>>> r = requests.post("http://httpbin.org/post", data=payload)
>>> print(r.text)

{
  ...
  "form": {
    "key2": "value2",
    "key1": "value1"
  },
  ...
}           

• files參數，上傳檔案，dict格式。

>>> url = 'http://httpbin.org/post'
>>> files = {'file': open('report.xls', 'rb')}
>>> r = requests.post(url, files=files)
>>> r.text

{
  ...
  "files": {
    "file": "<censored...binary...data>"
  },
  ...
}           

注意：建議用二進制模式(binary mode)打開檔案。這是因為 Requests 可能會試圖為你提供 Content-Length header，在它這樣做的時候，這個值會被設為檔案的位元組數（bytes）。如果用文本模式(text mode)打開檔案，就可能會發生錯誤。

• timeout參數設定逾時時間（秒），到達這個時間之後會停止等待響應：

>>> requests.get('http://github.com', timeout=0.001)

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
requests.exceptions.Timeout:\
 HTTPConnectionPool(host='github.com', port=80):\
  Request timed out. (timeout=0.001)           

注意：timeout 僅對連接配接過程有效，與響應體的下載下傳無關。 timeout 并不是整個下載下傳響應的時間限制，而是如果伺服器在 timeout 秒内沒有應答，将會引發一個異常（更精确地說，是在 timeout 秒内沒有從基礎套接字上接收到任何位元組的資料時），如果不設定 timeout，将一直等待。

• allow_redirects參數

控制是否啟用重定向，bool類型，選擇True為啟用，選擇False為禁用

import requests
>>> r = requests.get('http://github.com', allow_redirects=False)
>>> r.status_code

301           

• proxies參數

設定代理，dict格式，key值為選擇的協定，可以分别設定http請求和https請求的代理。

import requests

proxies = {
  'http': 'http://10.10.1.10:3128',
  'https': 'http://10.10.1.10:1080',
}

requests.get('https://api.github.com/events', proxies=proxies)           

• verify參數可以傳入bool值或者string，預設為True。

如果設定為False的即為忽略對SSL證書的驗證；反之就是需要做驗證；如果傳入值為string的話，代表指定本地的證書作為用戶端證書。

• 從本地傳入證書

import requests>>> requests.get('https://github.com', verify='/path/to/certfile')           

• 忽略對SSL證書的驗證

import requests>>> requests.get('https://kennethreitz.org', verify=False)           

另外三個重要參數json、cookies、auth則會在後面的章節進行詳細的介紹。

接口請求斷言

接口請求斷言是指在發起請求之後，對傳回的響應内容去做判斷，用來檢視是否響應内容是否與規定的傳回值相符。

響應内容

在發起請求後，我們使用一個變量r存儲響應的内容，也就是Response對象。

>>> import requests
>>> r = requests.get('http://httpbin.org/get')
>>> print(r)
<Response [200]>
>>> import requests
>>> r = requests.get('http://httpbin.org/get')
>>> print(r)
<Response [200]>           

Response對象有很多功能強大的方法可以調用，比如直接擷取響應頭，擷取Unicode編碼後的響應内容，擷取二進制的響應内容，擷取原始的響應内容等等。

• 獲得響應頭

>>> r.headers
{'Date': 'Sun, 05 Apr 2020 16:38:09 GMT', \
'Content-Type': 'application/json', \
'Content-Length': '308', 'Connection': 'keep-alive',\
 'Server': 'gunicorn/19.9.0', \
 'Access-Control-Allow-Origin': '*', \
 'Access-Control-Allow-Credentials': 'true'}           

• 獲得編碼後的響應值

>>> print(r.text)
{
  "args": {}, 
  "data": "", 
  "files": {}, 
  "form": {
    "hogwarts": [
      "a", 
      "b", 
      "c"
    ]
  }, 
  "headers": {
    "Accept": "*/*", 
    "Accept-Encoding": "gzip, deflate", 
    "Content-Length": "32", 
    "Content-Type": "application/x-www-form-urlencoded", 
    "Host": "httpbin.org", 
    "User-Agent": "python-requests/2.22.0", 
    "X-Amzn-Trace-Id": "Root=1-5e8a01e3-0913fca09ac605ccc911ccde"
  }, 
  "json": null, 
  "origin": "113.118.101.232", 
  "url": "http://httpbin.org/post"
}           

還可以使用r.raw獲得原始響應内容，r.content獲得二進制的響應内容，另外還有編碼為json格式的響應内容，會在後面的章節進行詳述。