Python接口测试中Json返回怎么快速校验_使用pytest-json-report插件

夜萱小哥_9034

夜萱小哥_9034

2026-04-29

431人浏览

原创

pytest-json-report默认不捕获接口响应体,需通过pytest_json_extra钩子手动注入response.json()等数据到report.user_properties,注意异常处理与大小限制。

python接口测试中json返回怎么快速校验_使用pytest-json-report插件

pytest-json-report 生成的 JSON 报告里没有接口响应体?

不是插件问题,是它默认只记录测试结果(pass/fail)、耗时、用例名,response.json() 这类运行时数据根本不会自动捕获。想校验返回 JSON,得自己把数据塞进去——要么在测试函数里主动写入,要么用 fixture 拦截响应。

常见错误现象:pytest --json-report 生成的 report.json 文件里搜不到 "data" 或 "code" 字段,误以为插件支持自动解析接口返回。

  • 必须手动将响应内容存到 pytest 的 test_report 对象里,或通过 extra 参数传给插件
  • 推荐在 fixture 中统一处理:用 requests.Response 对象调用 .json(),再用 pytest_json_extra 钩子注入
  • 注意异常分支:如果接口返回非 JSON(如 502、空响应、HTML 错误页),.json() 会抛 JSONDecodeError,必须 try/except 包裹,否则测试直接中断

如何把接口响应 JSON 写进 pytest-json-report 的 report.json?

核心是利用插件提供的 pytest_json_extra 钩子函数,在测试执行后往报告里加字段。不能靠装饰器或 print,必须走这个钩子路径。

实操建议:

  • 在 conftest.py 里定义 pytest_json_extra 函数,接收 report 和 config 参数
  • 用 report.user_properties 存原始响应(response.text)或解析后结构(response.json()),例如:report.user_properties.append(("response_json", resp_json))
  • 确保你的测试函数把 response 对象存到了 report.user_properties 或通过 pytest.mark 传参带过去;否则钩子拿不到数据
  • 避免直接存大文件或二进制响应体,会撑爆 report.json;超 10KB 建议只存 status_code、keys()、len(data) 等摘要信息

用 pytest-check 替代断言 + pytest-json-report 能否自动记录失败详情?

可以,但和 pytest-json-report 是两套逻辑:pytest-check 只负责让单个测试不因一个 assert 失败就退出,它的失败信息默认写进 pytest 的 stdout,不会自动进 report.json。

Li Python Sec Check
Li Python Sec Check

Python 安全规范检查工具:基于 CloudBase 规范、腾讯安全指南,LLM 智能分析(默认禁用,优先本地执行)

下载

要让它出现在 JSON 报告里,仍需配合钩子:

  • 在 pytest_runtest_makereport 钩子里检查 report.failed 且 "check" in report.longreprtext
  • 从 report.longreprtext 提取关键校验点(比如 “expected key ‘msg’”),写入 report.user_properties
  • 别依赖 pytest-check 自动注入 JSON 字段——它没这个设计,强行读 sys.stdout 捕获也不稳定
  • 更稳的做法:用 pytest-assume + 自定义 fixture 封装 assert,每次校验都显式调用 record_property("json_check", {...})

校验 JSON 结构时,$ref、nullable、enum 怎么对应到 Python 断言?

OpenAPI 规范里的这些字段,Python 测试里没法直接“映射”,得拆解成具体判断。比如 "nullable": true 不代表字段可为 None 就完事,还要看它在响应里实际是否出现、类型是否匹配。

典型处理方式:

  • $ref → 手动展开引用的 schema,提取 properties 定义,用 jsonschema.validate() 校验,错误信息比手写 assert 清晰
  • "nullable": true → 先检查字段是否存在(key in data),再检查值是否为 None 或符合类型(如 isinstance(data.get("id"), (int, type(None))))
  • "enum": ["open", "close"] → 不要用 in 粗暴判断,先确认字段存在且非空,再做 assert data["status"] in {"open", "close"},避免 KeyError 掩盖真实问题
  • 性能影响:每轮测试跑完整 jsonschema 校验会慢 20–50ms,高频用例建议只在校验入口响应或 nightly pipeline 里启用

真正麻烦的不是怎么写校验逻辑,而是谁来维护 JSON Schema 和测试断言的一致性——接口字段一变,分散在各处的 assert key in data 很容易漏改。不如把 schema 当唯一源,测试只负责调用校验函数。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1671

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4164

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1669

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

24117

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2947

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2987

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1163

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2303

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程