在Python中如何使用pytest测试GraphQL接口

冬明大大_7285

冬明大大_7285

2026-09-20

414人浏览

原创

直接用requests.post发graphql请求最可靠,关键在于构造合法json体(query和variables字段)、设置content-type: application/json,并用fixture复用session;遇graphqlerror需根据errors.locations和message定位schema或resolver问题。

在python中如何使用pytest测试graphql接口

pytest怎么调用GraphQL接口做集成测试

直接用 requests.post 发请求最可靠,别被 pytest 插件带偏——多数 GraphQL 测试不需要额外插件,尤其当你只验证后端逻辑或 API 行为时。

关键不是“用什么框架”,而是「构造合法的 GraphQL 请求体」+「校验响应结构」。常见错误是把 query 当成 URL 参数传,或者漏掉 Content-Type: application/json 导致服务端解析失败。

  • query 必须放在 JSON body 的 "query" 字段里,变量(如有)放 "variables" 字段
  • 务必设置 headers={"Content-Type": "application/json"},否则 Flask/Starlette/FastAPI 可能返回 400
  • json.dumps() 序列化请求体,别手动拼字符串(容易引号错乱)
  • 测试前确保 GraphQL 服务已启动(比如用 pytest --base-url=http://localhost:8000 传入地址)

示例:

import requests
import json

def test_user_query():
    url = "http://localhost:8000/graphql"
    query = '''
    query GetUser($id: ID!) {
        user(id: $id) {
            id
            name
            email
        }
    }
    '''
    response = requests.post(
        url,
        json={"query": query, "variables": {"id": "1"}},
        headers={"Content-Type": "application/json"}
    )
    assert response.status_code == 200
    data = response.json()
    assert "data" in data
    assert data["data"]["user"]["name"] == "Alice"

如何复用 client 实例避免重复创建 session

每次测都新建 requests.Session() 没问题,但如果你有鉴权头、cookie 或需要连接复用(比如测批量请求),就该封装一个 fixture。

pytest fixture 是最自然的解法——它比全局变量安全,比类属性清晰,还能自动管理生命周期。

  • @pytest.fixture 返回带默认 headers 的 requests.Session 实例
  • 在 fixture 里注入 token(比如从环境变量或登录接口获取),避免每个 test 重复登录
  • 注意 session 不会自动关闭,加 yield + session.close() 更稳妥
  • 不要在 fixture 里硬编码 URL,用 pytest.config.getoption("--base-url") 动态传入

示例 fixture:

Python数据分析(免费版)
Python数据分析(免费版)

提供Python数据清洗、统计分析与可视化建议,覆盖业务报表与科研数据的快速处理流程。

下载
@pytest.fixture
def gql_client():
    session = requests.Session()
    session.headers.update({"Authorization": "Bearer test-token"})
    yield session
    session.close()

def test_create_post(gql_client):
    resp = gql_client.post(
        "http://localhost:8000/graphql",
        json={"query": "mutation { createPost(title: \"Test\") { id } }"}
    )
    assert resp.json()["data"]["createPost"]["id"]

遇到 GraphQLError 怎么定位是 schema 还是 resolver 问题

当响应里出现 "errors" 字段,先别急着改测试代码——90% 是你发的 query 本身不合法,或字段名/类型写错了。

重点看 errors[0]["locations"] 提供的行列号,它指向的是服务端解析后的 AST 位置,不是你原始字符串的位置(尤其用了三引号或 f-string 时)。

  • 错误信息里含 "message": "Cannot query field ..." → schema 里没定义该字段,检查 SDL 或 resolver 注册
  • "Unknown type""Expected type ..." → query 中标量/输入类型和 schema 不匹配(比如传了 String 却要 ID
  • "Internal server error" 且无 stacktrace → resolver 抛了未捕获异常,需查服务端日志
  • print(response.json()) 配合断点,别只看 status_code —— GraphQL 协议规定即使出错也返回 200

要不要用 pytest-graphql 或 gql 这类库

没必要,除非你在写大量复杂 mutation 并需要自动生成变量类型校验。对绝大多数后端集成测试,它们只是多一层抽象、少一点控制。

gql 库主打 client 端查询执行(比如 Electron 桌面应用),在 pytest 里用反而增加依赖和学习成本;pytest-graphql 停更多年,不支持现代 ASGI 服务(如 Strawberry + Starlette)。

  • 纯 HTTP 测试:坚持用 requests,稳定、调试直观、报错明确
  • 需要 mock 服务端响应:用 responsespytest-mock patch requests.post,别 mock GraphQL 层抽象
  • 真要类型安全:用 graphql-codegen 生成 Python types,再配合 pydantic 校验响应,而不是换测试库

真正容易被忽略的点是:GraphQL 响应里的 "data""errors" 是并存的(partial success),测试断言时得同时处理两者,不能只查 data 是否存在。

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

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1531

4

python能做什么
python能做什么

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

2023.07.25

3584

7

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

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

2023.07.31

1549

3

python教程
python教程

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

2023.08.03

20317

23

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

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

2023.08.04

2527

5

python eval
python eval

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

2023.08.04

2587

5

scratch和python区别
scratch和python区别

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

2023.08.11

1063

5

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

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

2023.08.10

576

4

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

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

2023.08.11

2003

5

热门下载

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

精品课程

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