理解 HTTP POST 请求中的 json 和 data 参数

在使用 Python 发送 HTTP POST 请求时(无论是使用 requests 还是 aiohttp),jsondata 参数有明确的区别和使用场景。理解这些区别对正确构建请求至关重要。

关键区别

特性 json 参数 data 参数
内容类型 自动设置为 application/json 需要手动设置(默认是 application/x-www-form-urlencoded
数据处理 自动序列化 Python 对象为 JSON 需要手动序列化
使用场景 API 请求(JSON-RPC, RESTful API) 表单提交、文件上传、自定义格式
编码 UTF-8 取决于内容类型
易用性 更简单(自动处理) 需要更多手动工作
  1. 何时使用 data

参数: 使用场景:

  1. 表单提交(HTML 表单数据):

    python

    复制代码
    form_data = {"username": "john", "password": "secret"}
    response = requests.post("https://example.com/login", data=form_data)
  2. 文件上传

    python

    复制代码
    files = {"file": open("report.pdf", "rb")}
    response = requests.post("https://example.com/upload", files=files)
  3. 发送原始文本(非 JSON):

    python

    复制代码
    xml_data = "<user><name>John</name></user>"
    response = requests.post("https://example.com/api", 
                            data=xml_data,
                            headers={"Content-Type": "application/xml"})
  4. 多部分表单数据

    python

    复制代码
    from aiohttp import FormData
    
    form = FormData()
    form.add_field("username", "john")
    form.add_field("avatar", open("avatar.jpg", "rb"), 
                  filename="avatar.jpg",
                  content_type="image/jpeg")
    
    async with session.post(url, data=form) as response:
  5. 自定义内容类型

    python

    复制代码
    custom_data = "custom format data"
    response = requests.post("https://example.com/api", 
                            data=custom_data,
                            headers={"Content-Type": "text/plain"})

2. 何时使用 json 参数

使用场景:

  • 当 API 期望接收 JSON 格式的数据时(大多数现代 API 使用 JSON)

  • 当需要发送结构化数据(字典、列表等)

  • 当 API 文档指定请求体应为 JSON

示例:

python

复制代码
import requests

data = {"name": "John", "age": 30}
response = requests.post("https://api.example.com/users", json=data)

在 aiohttp 中:

python

复制代码
async with session.post(url, json=params) as response:

优点:

  1. 自动设置 Content-Type: application/json

  2. 自动将 Python 对象序列化为 JSON

  3. 简化代码

3. 最佳实践建议

  1. 推荐使用 json=params

    python

    复制代码
    response = requests.post(url, headers=headers, json=params, timeout=60)
    • 更简洁

    • 更安全(自动处理序列化)

    • 自动设置正确的 Content-Type

  2. 如果使用 data,必须手动序列化

    python

    复制代码
    response = requests.post(url, headers=headers, data=json.dumps(params), timeout=60)
    • 确保传递的是字符串,不是字典, 手动将`params`字典序列化为JSON字符串,然后通过`data`参数发送

    • 确保设置了正确的 Content-Type

  3. 避免使用 data=params

    • 这总是错误的,除非您确实想发送表单数据, 这会将`params`字典编码为`application/x-www-form-urlencoded`格式(即表单数据),而不是JSON。

    • 对于 JSON API,会导致服务器解析错误

相关推荐
G皮T13 分钟前
【安全】TLS 协议介绍
安全·http·网络安全·https·ssl·tls·tls 1.3
会开花的二叉树1 小时前
上手 cpp-httplib:轻量级 C++ HTTP 库的安装与实战指南
开发语言·c++·http
FreeBuf_4 小时前
Zloader木马再次升级:通过DNS隧道和WebSocket C2实现更隐蔽的攻击
websocket·网络协议·php
chuxinweihui4 小时前
Socket编程UDP
linux·网络·网络协议·udp·通信
北京耐用通信4 小时前
神秘魔法?耐达讯自动化Modbus TCP 转 Profibus 如何为光伏逆变器编织通信“天网”
网络·人工智能·网络协议·网络安全·自动化·信息与通信
游戏开发爱好者86 小时前
TCP 抓包分析:tcp抓包工具、 iOS/HTTPS 流量解析全流程
网络协议·tcp/ip·ios·小程序·https·uni-app·iphone
kimi7048 小时前
HTTP的持续与非持续连接,HTTP报文格式
网络·网络协议·http
半桔8 小时前
【网络编程】TCP 粘包处理:手动序列化反序列化与报头封装的完整方案
linux·网络·c++·网络协议·tcp/ip
会跑的葫芦怪10 小时前
Go语言net/http库使用详解
http·golang·iphone