Skip to main content

har2pytest

从 HAR 抓包文件和 Swagger 文档生成 Python API 接口文件,并自动生成 pytest + allure 参数化测试用例的 CLI 工具。

安装

pip install har2pytest

验证安装:

har2pytest --help

快速开始

1. 从 HAR 文件生成 API 文件

# 生成 API 文件(同步/异步统一,运行时自动适配)
har2pytest api api_request.har

2. 从 Swagger 文档生成 API 文件

har2pytest swagger https://petstore.swagger.io/v2/api-docs

3. 生成测试用例

命令格式:

har2pytest testcase [har_file] --pattern <模式> [options]

参数说明:

参数 缩写 默认值 说明
har_file - api_request.har HAR 文件路径(位置参数,可省略)
--pattern - list_query 生成模式:list_query / complex_scenario / batch
--url -u - 目标接口 URL,指定后只生成该接口的测试用例
--mark -m - pytest 标记(如 test_4291),生成 @pytest.mark.test_4291
--output -o testcases 测试用例输出目录
--api-dir - apis API 文件目录(用于匹配 API 文件)
--api-files - api_request.har batch 模式专用:API 文件目录或 HAR 文件,多个用逗号分隔
--overwrite - False 强制覆盖已存在的测试用例文件
--async - False 生成异步模式代码(async/await + async_client)

示例:

# 查询类参数化测试(指定 URL)
har2pytest testcase api_request.har --pattern list_query --url /api/user/list

# 查询类参数化测试(全参数),生成异步测试用例
har2pytest testcase api_request.har \
  --pattern list_query \
  --url /api/user/list \
  --mark test_4291 \
  --output testcases/async \
  --api-dir apis \
  --overwrite \
  --async

# 复杂场景流程测试(多步骤业务流),生成同步测试用例
har2pytest testcase api_request.har \
  --pattern complex_scenario \
  --url /api/order/create \
  --mark test_5012 \
  --output testcases/sync \
  --api-dir apis \
  --overwrite

# 批量生成(指定 API 文件目录,无 HAR 文件)
har2pytest testcase \
  --pattern batch \
  --api-files apis/mall_store_application \
  --output testcases/sync \
  --api-dir apis \
  --overwrite

# 批量生成(指定 HAR 文件,自动提取接口并匹配 API 文件)
har2pytest testcase \
  --pattern batch \
  --api-files api_request.har \
  --output testcases/sync \
  --api-dir apis

# 批量生成(多个 API 文件目录,用逗号分隔)
har2pytest testcase \
  --pattern batch \
  --api-files apis/mall_store_application,apis/mall_center_member \
  --output testcases/sync \
  --overwrite

# 异步模式测试用例(生成 async/await 代码,自动切换为 async_client)
har2pytest testcase api_request.har \
  --pattern list_query \
  --url /api/user/list \
  --output testcases/async \
  --async \
  --overwrite

4. 查看 HAR 文件摘要

har2pytest summary api_request.har

详细文档

文档 说明
API 文件生成 从 HAR / Swagger 生成 API 文件的详细说明
HAR 文件解析 HAR 解析规则与参数过滤
Swagger 文档解析 Swagger 文档获取与参数提取
测试用例生成模式 list_query / complex_scenario / batch 三种模式详解

配置

在项目根目录创建 har2pytest_config.json 自定义配置。配置项详见 APIConfig 类(config.py)。

项目结构

har2pytest/
├── har2pytest/              # 核心代码
│   ├── __init__.py
│   ├── __main__.py          # CLI 入口
│   ├── client.py            # HTTP 客户端 (Client, AsyncClient)
│   ├── config.py            # 配置管理 (APIConfig)
│   ├── har_parser.py        # HAR 文件解析 (HARParser)
│   ├── har_generator.py     # HAR → API 文件生成
│   ├── api_generator.py     # API 文件生成 (APIGenerator)
│   ├── swagger_handler.py   # Swagger 文档处理 (SwaggerHandler)
│   ├── testcase_generator.py # 测试用例生成 (TestCaseGenerator)
│   ├── url_matcher.py       # URL 规范化与匹配 (URLMatcher)
│   ├── utils.py             # 工具函数
│   └── logger.py            # 日志配置
├── docs/                    # 详细文档
├── tests/                   # 单元测试
│   └── har2pytest_config_test.json  # 测试配置示例
├── pyproject.toml           # 项目配置
└── mkdocs.yml               # 文档站点配置

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

har2pytest-1.4.3.tar.gz (92.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

har2pytest-1.4.3-py3-none-any.whl (56.1 kB view details)

Uploaded Python 3

File details

Details for the file har2pytest-1.4.3.tar.gz.

File metadata

  • Download URL: har2pytest-1.4.3.tar.gz
  • Upload date:
  • Size: 92.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for har2pytest-1.4.3.tar.gz
Algorithm Hash digest
SHA256 983b132acb0005198e789beebef1fead1b0f6e344675004042863d0752c3ede6
MD5 affd6289a1c1b80be4e318d2458d4281
BLAKE2b-256 2c76766d554695c5dd0913eff395c442ada82777588010fab22e0f2448a4784e

See more details on using hashes here.

Provenance

The following attestation bundles were made for har2pytest-1.4.3.tar.gz:

Publisher: publish.yml on hewei198711/har2pytest

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file har2pytest-1.4.3-py3-none-any.whl.

File metadata

  • Download URL: har2pytest-1.4.3-py3-none-any.whl
  • Upload date:
  • Size: 56.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for har2pytest-1.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3666f367ec5dc215ee626ba57564afdd37a93f83e1cc1683e8fb5bb1dedb1d0f
MD5 fefd5b0167793d843ae34b755671d86f
BLAKE2b-256 d91df0f0f2dfc26a438eb777a167ae1013083d881e018c623e68b78388d03fd7

See more details on using hashes here.

Provenance

The following attestation bundles were made for har2pytest-1.4.3-py3-none-any.whl:

Publisher: publish.yml on hewei198711/har2pytest

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page