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

如何在测试中自动生成API的示例代码段

胖辰小哥_6248

胖辰小哥_6248

发布时间:2026-02-12 17:26:45

|

799人浏览过

|

来源于php中文网

原创

最省力的示例代码生成方式是用 openapi-generator 从 OpenAPI Spec 直接生成:先用 html2 验证 spec 合法性,再按需选 python/postman 等模板输出可执行片段,配合 pytest 参数化、httpx+pydantic 运行时组装及 curl 安全转义,确保示例真实、隔离、易维护。

如何在测试中自动生成api的示例代码段

用 openapi-generator 从 OpenAPI Spec 直接生成示例代码

如果你已有符合规范的 openapi.yaml 或 swagger.json,这是最省力、可复现的方式。它不依赖运行时,也不需要手写 mock 逻辑。

常见错误是直接跑默认命令却没指定语言或模板,结果输出一堆 Java 文件——其实你只想要 Python 的 requests 示例片段。

  • 用 openapi-generator generate -i openapi.yaml -g html2 先验证 spec 是否合法(html2 模板能快速暴露格式问题)
  • 生成纯调用示例:用 -g python + --additional-properties=generateSourceCodeOnly=false,hideGenerationTimestamp=true,再删掉模型类和 client 初始化部分,只留 api_instance.xxx_with_http_info(...) 调用块
  • 若要更轻量的 curl 或 requests 片段,优先选 -g postman 导出 collection,再用脚本抽取出 request.url、request.method 和 request.body 字段
  • 注意 openapi-generator v6+ 默认启用 strict mode,遇到 x-example 缺失的字段会跳过示例生成;加 --strict-spec=false 可绕过(但建议补全 spec)

在 Pytest 中用 pytest_generate_tests 动态注入参数化示例

适合已有测试骨架、想把 API 示例当数据驱动用的场景。不是生成文档,而是让每个示例变成一个独立 test case。

容易踩的坑是把示例硬编码进 params 列表里,导致 spec 更新后测试失效。

  • 把示例统一放在 tests/examples/ 下,按 {endpoint}_{method}.json 命名,内容含 url、method、headers、body、expected_status
  • 在 conftest.py 里用 pytest_generate_tests 扫描该目录,用 metafunc.parametrize 注入 example_data fixture
  • 测试函数签名写成 def test_api_example(example_data):,内部用 requests.request(**example_data) 发起调用
  • 别在 example_data 里塞真实敏感值(如 token),用占位符如 {auth_token},启动测试前用环境变量替换

用 httpx + pydantic 在运行时拼接可执行示例

当 API 尚未稳定、spec 经常变,又需要开发者立刻看到“这段代码真能跑”,就得在测试里现场组装请求样例。

性能上几乎无影响,但要注意 pydantic 模型的 model_dump() 默认不包含 None 字段,而有些 API 要求显式传 null。

  • 定义请求模型继承 BaseModel,字段加 examples 参数,如 user_id: int = Field(..., examples=[123])
  • 用 model_construct() + model_dump(exclude_unset=True) 生成最小有效 payload
  • 发请求前用 httpx.Request(method, url, json=payload).prepare().content 提取原始字节,方便断言或日志输出
  • 如果 endpoint 有 path param(如 /users/{id}),别手动字符串格式化,用 str(url).format(id=123) 更安全

curl 示例生成器容易忽略的 Content-Type 和编码细节

很多工具生成的 curl 命令看着对,一粘贴就 400,八成是 -H "Content-Type: application/json" 没加,或者 JSON 里中文被转义错乱。

OpenAPI spec 里的 example 是 raw string,但 curl 命令里必须是 shell-safe 的字符串。

  • 用 json.dumps(obj, ensure_ascii=False, separators=(',', ':')) 生成紧凑 JSON,再用 shlex.quote() 包裹,避免空格和单引号破坏命令结构
  • GET 请求带 query 参数时,别用 -d,改用 -G --data-urlencode;否则参数会被当成 body 发送
  • 上传文件示例不能只写 -F "file=@/path/to/file",得补上 -H "Content-Type: multipart/form-data" —— 实际 curl 会自动设,但别人复制时容易漏掉注释说明
  • 如果 API 要求 Bearer token,示例里写 -H "Authorization: Bearer {token}",而不是填死值;并在文档顶部注明 token 来源
生成示例代码不是拼凑语法,关键在三点:是否反映真实调用链路、是否隔离了环境依赖、是否让使用者一眼看出哪部分要替换成自己的值。越早把 {placeholder} 和真实值区分开,后续维护成本越低。

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

热门AI工具

更多
SkildArt
SkildArt Hot

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

DeepSeek

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

Laper
Laper Hot

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

WorkBuddy

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

Seko
Seko Hot

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

豆包大模型

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

花生AI
花生AI Hot

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

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

519

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

616

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1196

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

791

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1766

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

5014

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

2314

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

4206

2025.06.17

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

热门下载

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

精品课程

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

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