从本期开始,将开启《保姆级Pytest接口自动化测试框架实战指南》系列。
本文系列文章中第一期,用于我们项目中接口调用之Requests说明。
前言
为什么笔者大言不惭的说Requests就是接口自动化测试的终极奥义呢?因为在接口测试中,对接口的请求处理是最基本的,也是最核心的,掌握了最基本的接口请求处理,其他花里胡哨的功能都是锦上添花而已,那么如何在Python中进行接口请求呢?那么本文将给大家介绍Python中的接口请求秘诀。
这里我们使用的是Requests
类库,它是使用Python语言编写的一个用于在Python环境中发出标准HTTP请求的模块,简单易用,是接口测试必备神器。
官网中对requests的介绍是:for human beings
使用到的工具
-
编程语言: Python 3.8
-
编译器: Pycharm
-
Python类: Requests
1. HTTP 请求介绍
在了解Requests之前我们先看看HTTP的简单介绍。
我们知道,一个 HTTP 请求由三部分构成:
- 请求URL:包含请求方法(常用的有 GET, POST)、请求地址和 HTTP 协议版本
- 请求头:包含一个或多个键值对
- 请求报文:(可选,例如GET请求参数在URL中设置就无需报文,而POST方法的报文可以是一个json文本)
2. Requests介绍
Requests
提供了几乎所有 HTTP 方法的功能:GET
、OPTIONS
、HEAD
、POST
、PUT
、PATCH
、DELETE
,另外,它提供了 headers
参数让我们根据需求定制请求头。
2.1 Requests库的几个主要方法
方法名 | 方法作用 |
---|---|
requests.request() | 构造一个请求,支持以下各种方法 |
requests.head() | 获取html头部信息的主要方法 |
requests.get() | GET请求的方法 |
requests.post() | POST请求的方法 |
requests.put() | PUT请求的方法 |
requests.patch() | PATCH请求的方法:用于交局部修改的请求 |
requests.delete() | DELETE请求的方法:用于删除请求 |
这其中GET、POST这两个方法是我们平时最常用的方法,我们下面也将对GET、POST这两个方法做一个简单的介绍。
3. requests.get()
使用方法:requests.get(
url
,params
,**kwargs
)
- url: 接口请求地址
- params: 请求的参数,即url中的额外参数,可选。
- **kwargs: 12个控制访问的参数
requests.get()方法中的的url参数能从字面意思了解其功能,我们这边来主要讲讲params
和**kwargs
参数:
-
params
:字典或字节序列, 作为参数增加到url中,使用这个参数可以把一些键值对以?key1=value1&key2=value2的模式增加到url中
例如:
key_value = {'key1':' values', 'key2': 'values'}
response = requests.get('http://www.python123.abc', params=key_value)
-
**kwargs
:用于控制访问的参数,上面我们提到的params也是属于其控制范围,我们再介绍几个常用的参数
1. data:数据格式为字典,字节序或文件对象,重点作为向服务器提供或提交资源是提交,,作为request的内容,与params不同的是,data提交的数据并不放在url链接里, 而是放在url链接对应位置的地方作为数据来存储。,它也可以接受一个字符串对象。
2. json:数据格式为json,也是经常使用的数据格式,他是作为内容部分可以向服务器提交。
例如:
key_value = {'key1': 'value1'}
response = requests.post('http://www.python123.abc', json=key_value)
3. headers:数据格式为字典,是向url访问时所发起的http的请求头参数。
例如:
http_headers = {'Content-Type': 'application/json'}
response = requests.post('http://www.python123.abc', headers=http_headers)
4. cookies:数据格式为字典或CookieJar,指的是从http中解析cookie
5. auth:数据格式为元组,用来支持http认证功能
6. timeout:数据格式为一个数值,用于设定超时时间, 单位为秒(当发起一个get请求时可以设置一个timeout时间, 如果在timeout时间内请求内容没有返回, 将产生一个timeout的异常)。
4. requests.post()
post(url, data, json, **kwargs)
- url: 接口请求地址
- data,json: 请求的参数。
- **kwargs: 12个控制访问的参数
这其中data
,json
,**kwargs
这几个参数方法已经在上方有所介绍,只是接口请求方法已经在方法名中有所体现,请求方式为POST。
post接口请求与get请求不同点在于请求参数是存放在请求体中的,通常是一个xml
或json
格式的报文载体。
5. Response对象
既然有HTTP请求信息,那么就有HTTP返回信息,下面我们再介绍一下 response
对象。
-
response
:
response对象有以下属性:
属性名 | 属性说明 |
---|---|
response.status_code | http请求的返回状态,例如200则表示请求成功 |
response.text | http响应内容的字符串形式,即接口返回的报文主体 |
response.encoding | 从http header 中猜测的相应内容编码方式 |
response.apparent_encoding | 从内容中分析出的响应内容编码方式(备选编码方式) |
response.content | http响应内容的二进制形式 |
response对象还有以下方法:
方法名 | 方法作用 |
---|---|
response.json() | 将接口返回报文信息解析为json格式的报文 |
responseiter_content() | 配置stream=True,指定chunk_size大小 |
response.iter_lines() | 配置stream=True,每次返回一行 |
response.raise_for_status() | 控制返回状态码为400-500之间将抛出异常 |
response.close() | 关闭请求 |
response
对象的方法使用比较简单,看方法名即可在项目中灵活使用。
6. 综合示例
下面的示例是使用GET方式请求接口,将返回信息处理成json格式,通过节点名称的方式获取对应节点value值并返回。
@staticmethod
def get_singerlist():
"""
获取接口返回报文中的歌手列表
:return:
"""
global singerlist
url_singerlist = CommonInfo().get_url_singerlist()
response = requests.get(url=url_singerlist)
jsonres = response.json()
singerlist = jsonres['singerList']['data']['singerlist']
return singerlist
总结
以上就是我们使用 Requests类库在Python中进行接口请求的简单说明,还是比较简单易懂的,该终极奥义是我们本系列文章的基础,其他功能都是基于此基本上进行拓展开来的,Requests类库还有其他很多丰富的功能等待各位去发掘和探索,在此不做详细介绍了。
下一期将进行requests项目实战。