讲师中心 微信公众号
AI工具推荐 视频效率加速

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

冬明大大_7285

冬明大大_7285

发布时间:2026-09-20 06:14:26

|

414人浏览过

|

来源于php中文网

原创

直接用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。

立即学习Python免费学习笔记(深入)”;

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

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

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

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

示例 fixture:

@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 是否存在。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

相关专题

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

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

1531

2023.07.20

python能做什么
python能做什么

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

3584

2023.07.25

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

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

1549

2023.07.31

python教程
python教程

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

20377

2023.08.03

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

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

2527

2023.08.04

python eval
python eval

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

2587

2023.08.04

scratch和python区别
scratch和python区别

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

1063

2023.08.11

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

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

576

2023.08.10

AI视频生成软件推荐
AI视频生成软件推荐

本专题汇总了当前主流的AI视频生成软件推荐与排行榜单,涵盖seko、AniShort、剧云、Lovart、LiblibAI及立刻mv等热门工具。同时整理了各软件在文生视频、图生视频、时长限制、画质表现及免费额度等方面的差异对比,助您快速选对适合创作需求的AI视频生成工具。

160

2026.09.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn