Pytest自动化测试中存储大API请求Payload的优化方案问询

针对你提到的大Payload维护、重复值替换的问题，推荐几个更高效的实现方式：

1. 用Jinja2模板替代硬编码JSON #

把每个场景的Payload存成独立的.json.j2模板文件，直接用占位符标记动态字段，不用自己写递归替换函数。Jinja2支持变量替换、逻辑判断、循环，完全适配复杂Payload的需求。

示例：

• 创建scenario_1.json.j2文件：

{
  "api_version": "v2",
  "operation_id": "{{ operation_id }}",
  "initiator": {
    "name": "{{ initiator_name }}",
    "email": "{{ initiator_email }}"
  },
  "approver": {
    "name": "{{ approver_name }}",
    "email": "{{ approver_email }}"
  },
  // 其他200+行内容
}

• 测试代码中渲染模板：

from jinja2 import Environment, FileSystemLoader
from faker import Faker

fake = Faker()
env = Environment(loader=FileSystemLoader("payload_templates"))

def prepare_test_data(scenario_name):
    template = env.get_template(f"{scenario_name}.json.j2")
    return template.render(
        operation_id=fake.uuid4(),
        initiator_name=fake.name(),
        initiator_email=fake.email(),
        approver_name=fake.name(),
        approver_email=fake.email()
    )

# 使用时直接调用
payload = prepare_test_data("scenario_1")

2. 用Pydantic模型定义Payload结构 #

用Pydantic模型来结构化Payload，把常量字段默认值定义在模型里，动态字段在实例化时传入，既保证类型正确，又能轻松生成JSON。

示例：

from pydantic import BaseModel
from faker import Faker

fake = Faker()

# 基础模型：存放所有场景的常量字段
class BaseApiPayload(BaseModel):
    api_version: str = "v2"
    system_flag: bool = True
    timeout: int = 300

# 场景1的专属模型
class Scenario1Payload(BaseApiPayload):
    operation_id: str
    initiator: dict
    approver: dict

def get_scenario_1_payload():
    return Scenario1Payload(
        operation_id=fake.uuid4(),
        initiator={"name": fake.name(), "email": fake.email()},
        approver={"name": fake.name(), "email": fake.email()}
    ).model_dump_json(indent=2)

这种方式的好处是：自动校验字段类型、结构变更时只需修改模型、动态值和常量完全分离。

3. 拆分Payload为可复用模块 #

把Payload中重复出现的片段（比如用户信息、地址信息）抽成独立的生成函数，在各个场景Payload中引用，减少代码重复。

示例：

from faker import Faker

fake = Faker()

# 可复用的用户信息生成函数
def generate_user_profile():
    return {
        "name": fake.name(),
        "email": fake.email(),
        "phone": fake.phone_number(),
        "address": fake.address().replace("\n", ", ")
    }

# 场景1的Payload生成函数
def scenario_1_payload():
    return {
        "api_version": "v2",
        "operation_id": fake.uuid4(),
        "initiator": generate_user_profile(),
        "approver": generate_user_profile(),
        "auditors": [generate_user_profile() for _ in range(3)],
        # 其他大段内容
    }

4. 用配置文件管理常量 #

把所有静态常量（比如api版本、固定状态值）存到config.yaml或.env文件中，在测试代码中统一加载，避免硬编码在Payload里，修改时只需改配置文件。

示例config.yaml：

api_constants:
  api_version: "v2"
  default_status: "active"
  timeout: 300

加载配置的代码：

import yaml

with open("config.yaml", "r") as f:
    config = yaml.safe_load(f)

# 在Payload中引用
def scenario_1_payload():
    return {
        "api_version": config["api_constants"]["api_version"],
        "status": config["api_constants"]["default_status"],
        # 其他内容
    }

这些方案都能解决你当前的痛点：不用自己维护递归替换函数、Payload结构更清晰、动态值和常量分离、重复代码大幅减少。

内容的提问来源于stack exchange，提问作者imool