接口自动化相关知识总结

一、接口请求体-json

1、接口请求体简介

• 进行HTTP请求时，发送给服务器的数据。
• 数据格式类型可以是JSON、XML、文本、图像等格式。
• 请求体的格式和内容取决于服务器端API的设计和开发人员的要求。

正在
2、JSON 简介

• 是 JavaScript Object Notation 的缩写。
• 是一种轻量级的数据交换格式。
• 是理想的接口数据交换语言。
• Content-Type 为 application/json

post请求方法中有3种参数 
post(url, data=None, json=None)

如果请求体中用了data默认是表单格式。如果请求中用的是json  默认格式是json

二、接口响应断言

1、接口断言使用场景

• 问题：
  1. 如何确保请求可以发送成功。
  2. 如何保证符合业务需求。
• 解决方案：
  • 通过获取响应信息，验证接口请求是否成功，是否符合业务需求。

2、Requests 中的响应结果对象 

import requests
from requests import Response

# Response就是一个响应对象
r: Response = requests.get('http://www.example.com')

r: Response代表类型注解 ，详细可以了解以下博主的文章了解什么是类型注解

Python类型注解_python注解_zy010101的博客-CSDN博客

三、json响应体断言

1 什么是 JSON 响应体

JSON格式的响应体指的是HTTP响应中的消息体（message body），它是以JSON格式编码的数据。

• r.json()：返回 python 字典。
• 

2 若碰到复杂断言应该如何处理？

• 多层嵌套的数据提取与断言: JSONPath
• 整体结构响应断言: JSONSchema
• 自行编写解析算法

四、接口请求体-文件

 

 五、接口请求体-xml

 

 

六、cookie处理

 

 

 六、超时处理

1、请求超时

2、为什么接口测试需要请求超时处理

未设置超时请情况下：

case1 -> server : 发起请求 server -> case1 : 返回响应

case2 -> server !!: 用例2发起请求，服务端阻塞，迟迟没有响应

case3 -> case3 : 没有设置超时的情况下，等待case2执行完成

设置超时请情况下：

case1 -> server : 发起请求 server -> case1 : 返回响应

case2 -> case2 : 设置超时时间3s case2 -> server !!: 发起请求，服务端阻塞，迟迟没有响应 case2 -> case2: 3s后，用例2报出异常

case3 -> server : 接口用例3正常执行。 server -> case3: 返回响应

3、如何设置

import requests 
class TestReq: 
    def test_timeout(self):
          r = requests.get('http://github.com', timeout = 0.01)

七、整体结构响应断言

1、针对于“大响应数据”如何断言

• 针对主要且少量的业务字段断言。
• 其他字段不做数据正确性断言，只做类型与整体结构的校验。
• 与前面的版本进行 diff，对比差异化的地方。

 2、JSONSchema 简介

• 使用 JSON 格式编写的
• 可以用来定义校验 JSON 数据的结构
• 可以用来校验 JSON 数据的一致性
• 可以用来校验 API 接口请求和响应

3、JSONSchema 整体结构响应断言 

   预先生成对应结构的 Schema。

   将实际获取到的响应与生成的 Schema 进行对比。

4、JSONSchema 的生成

• 通过界面工具生成。
• 通过第三方库生成。
• 通过命令行工具生成。

通过界面工具生成-JSONSchema 的生成效果

JSON Schema 在线生成工具：https://app.quicktype.io

• 复制 JSON 数据
• 粘贴到在线生成工具中
• 自动生成 JSON Schema 数据

八、数据库操作与断言 

1、接口测试响应验证

如何在测试过程中验证接口没有 Bug？

1. 通过接口响应值
2. 通过查询数据库信息辅助验证

2、接口测试数据清理 

自动化测试过程中，会产生大量的脏数据，如何处理？

• 通过 Delete 接口删除
• 自动化测试使用干净的测试环境，每次自动化测试执行完成之前或之后做数据还原

3、接口自动化测试常用的数据库操作 

• 连接与配置
• 查询数据与断言

4、数据库封装（Python）

• 封装数据库配置
• 封装 sql 查询操作
• 调用方法执行 sql 语句

import pymysql

# 封装建立连接的对象
def get_conn():
    conn = pymysql.connect(
        host="xxxx.com",
        port=13306,
        user="test",
        password="test",
        database="litemall",
        charset="utf8mb4"
    )
    return conn
# 执行sql语句
def execute_sql(sql):
    connect = get_conn()
    cursor = connect.cursor()
    cursor.execute(sql)  # 执行SQL
    record = cursor.fetchone()  # 查询记录
    return record

if __name__ == '__main__':
    execute_sql("select * from litemall_cart where "
                "user_id=1 and deleted=0 and "
                "goods_name='hogwarts1'")

九、多层嵌套响应断言-利用jsonpath进行多层嵌套的响应断言

 1、JSONPath 简介

• 在 JSON 数据中定位和提取特定信息的查询语言。
• JSONPath 使用类似于 XPath 的语法，使用路径表达式从 JSON 数据中选择和提取数据。
• 相比于传统的提取方式，更加灵活，并且支持定制化。
• 

 2、JSONPath 如何使用

2-1、语法知识

 JSONPath 的练习环境：JSONPath Online Evaluator

JSONPath 的练习json代码：

{
  "store": {
    "book": [
      {
        "category": "reference",
        "author": "Nigel Rees",
        "title": "Sayings of the Century",
        "price": 8.95
      },
      {
        "category": "fiction",
        "author": "Evelyn Waugh",
        "title": "Sword of Honour",
        "price": 12.99
      },
      {
        "category": "fiction",
        "author": "Herman Melville",
        "title": "Moby Dick",
        "isbn": "0-553-21311-3",
        "price": 8.99
      },
      {
        "category": "fiction",
        "author": "J. R. R. Tolkien",
        "title": "The Lord of the Rings",
        "isbn": "0-395-19395-8",
        "price": 22.99
      }
    ],
    "bicycle": {
      "color": "red",
      "price": 19.95
    }
  },
  "expensive": 10
}

JSONPath 练习题目

• 获取所有书籍的作者
• 获取所有作者---   $..author
• 
• 获取 store 下面的所有内容---  $.store
• 
• 获取所有的价格
• 获取第三本书-----  $..book[2]
• 
• 获取所有包含 isbn 的书籍-----   $..book[?(@.isbn)]

 

• 获取所有价格小于 10 的书----  $..book[?(@.price<10)]

 

• 获取所有书籍的数量----   $..book.length
• 

 

 

2-2、第三方库调用-JSONPath 与代码结合（Python）

• 环境安装：pip install jsonpath

• # 具体的使用。
  jsonpath.jsonpath(源数据对象, jsonpath表达式)