如何在使用pytest测试Falcon 1.1.0 API时通过simulate_post发送JSON

由于Falcon 1.1.0版本还没提供直接传递JSON对象的json便捷参数（这个参数是后续版本才新增的），咱们得手动处理序列化和编码，再通过body参数传递，同时设置正确的请求头。具体操作如下：

核心要点 #

要成功发送JSON数据，你需要完成两件关键操作：

• 将Python字典序列化为JSON字符串，再编码成字节流（因为body参数只接收字节数据）
• 设置请求头的Content-Type为application/json，让Falcon识别出请求体的格式

完整测试示例 #

假设你已经有了Falcon应用和对应的资源，测试代码可以这么写：

import json
import pytest
from my_falcon_app import api  # 导入你的Falcon API实例

def test_post_json_data():
    # 1. 准备测试用的JSON数据（以字典形式定义）
    test_payload = {"product_name": "Test Item", "price": 99.99, "stock": 50}
    
    # 2. 把字典转成JSON字符串，再编码为UTF-8字节
    json_body = json.dumps(test_payload).encode("utf-8")
    
    # 3. 调用simulate_post，传入字节body和正确的请求头
    response = api.simulate_post(
        path="/products",  # 替换成你的API端点路径
        body=json_body,
        headers={"Content-Type": "application/json"}
    )
    
    # 4. 验证响应结果是否符合预期
    assert response.status_code == 200
    parsed_response = json.loads(response.content)
    assert parsed_response["status"] == "success"
    assert parsed_response["received_data"]["product_name"] == "Test Item"

对应的Falcon资源处理示例 #

确保你的资源类能正确解析JSON请求体，比如：

import falcon

class ProductResource:
    def on_post(self, req, resp):
        # req.media会自动解析JSON请求体为Python字典
        product_data = req.media
        
        # 这里可以添加业务逻辑，比如数据校验、存入数据库等
        # ...
        
        # 返回响应
        resp.media = {
            "status": "success",
            "received_data": product_data
        }
        resp.status = falcon.HTTP_200

注意事项 #

• 编码必须用utf-8，这是JSON的标准编码格式，避免出现乱码问题
• 不要漏掉Content-Type头，否则Falcon无法自动解析req.media，会导致解析失败
• 如果JSON数据包含特殊字符，json.dumps会自动处理转义，无需手动操作

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