使用 Python 的 requests 库发送 POST 请求（data vs json 参数详解）

2024-08-07 14:58:06 浏览数 (1)

在使用 Python 进行 Web 开发时，经常需要通过 HTTP 请求与服务器进行数据交换。requests 是一个流行的 Python 库，用于发送 HTTP 请求。在使用 requests.post() 方法时，我们经常会遇到 data 和 json 两个参数，它们在传递数据时有着不同的用途和行为。本教程将详细介绍这两个参数的区别，并且通过实例演示如何在 Django Rest Framework 中处理这些数据。

1. data 参数

在 requests.post() 方法中，data 参数主要用于发送表单编码的数据或二进制数据。当我们将数据传递给 data 参数时，requests 会将其编码为表单数据，并将 Content-Type 设置为 application/x-www-form-urlencoded。这种方式适合处理简单的键值对数据或文件上传等场景。

示例代码如下：

代码语言：python代码运行次数：3复制
import requests

url = 'http://example.com/api'
payload = {'key1': 'value1', 'key2': 'value2'}

response = requests.post(url, data=payload)

在这个示例中，payload 是一个字典，它会被编码为表单数据发送到指定的 URL。如果服务器期望接收表单数据或简单的键值对数据，那么使用 data 参数是一个合适的选择。

2. json 参数

与 data 参数不同，json 参数用于发送 JSON 格式的数据。当我们使用 json 参数时，requests 会自动将数据转换为 JSON 格式，并将 Content-Type 设置为 application/json。这种方式适合处理复杂的数据结构或者与 RESTful API 交互时常见的 JSON 数据传输。

示例代码如下：

代码语言：python代码运行次数：0复制
import requests

url = 'http://example.com/api'
payload = {'key1': 'value1', 'key2': 'value2'}

response = requests.post(url, json=payload)

在这个示例中，payload 是一个字典，通过 json 参数传递给 requests.post() 方法。requests 会自动将 payload 转换为 JSON 格式，并以 JSON 的形式发送到指定的 URL。

3. 区别和选择
  • 编码和 Content-Type：
    • 使用 data 参数时，数据会被编码为表单数据，并且 Content-Type 默认为 application/x-www-form-urlencoded。
    • 使用 json 参数时，数据会被编码为 JSON 格式，并且 Content-Type 会自动设置为 application/json。
  • 用途：
    • data 参数适合处理简单的表单数据或二进制数据。
    • json 参数适合处理复杂的数据结构或者与 RESTful API 交互时常见的 JSON 数据传输。
4. 在 Django Rest Framework 中的应用

假设我们有一个 Django Rest Framework 的视图函数，用于处理通过 POST 请求发送的数据：

代码语言：python代码运行次数：0复制
# views.py
from rest_framework.decorators import api_view
from rest_framework.response import Response
from rest_framework import status

@api_view(['POST'])
def process_post_data(request):
    received_data = request.data
    # 处理接收到的数据
    return Response({'message': 'Data received successfully', 'data': received_data}, status=status.HTTP_200_OK)

在另一个 Python 脚本中，我们可以使用 requests 库发送 JSON 数据到上述视图函数：

代码语言：python代码运行次数：2复制
import requests

url = 'http://127.0.0.1:8000/api/process_post_data/'
payload = {'key1': 'value1', 'key2': 'value2'}

response = requests.post(url, json=payload)
print(response.json())

这样，我们就可以利用 requests.post() 方法的 json 参数发送 JSON 数据到 Django Rest Framework 的 API，并在视图函数中处理这些数据。

结论

通过本教程，我们详细介绍了 requests.post() 方法中的 data 和 json 参数的区别和用法。理解并正确使用这两个参数，能够帮助我们在 Python Web 开发中更加高效地处理和传输数据，特别是在与 RESTful API 交互时，能够更好地支持复杂的数据结构和 JSON 数据传输需求。

腾讯技术创作特训营S8

0 人点赞