如何用 Python 的 requests 库发送 JSON 数据的 POST 请求

在现代 Web 开发中，客户端与服务器之间进行数据交换的需求越来越普遍。而在 Python 这个强大的编程语言中，requests 库是一个广泛使用且功能强大的 HTTP 请求库。特别是在进行 API 调用时，发送 POST 请求并附带 JSON 数据是一个非常常见的需求。

什么是 POST 请求？

POST 请求是一种用于向服务器发送数据的 HTTP 方法。与 GET 请求不同，POST 请求通常用于提交表单数据，上传文件，或者在 RESTful APIs 中创建新资源。发送 JSON 数据的 POST 请求，在 Web APIs 调用中尤为常见。

准备工作：安装和引入 requests 库

在开始之前，请确保你的计算机上已经安装了 Python，并且可以使用 pip 命令。如果你还没有安装 requests 库，可以通过以下命令安装：

pip install requests

安装完成后，在你的 Python 脚本中引入 requests 库：

import requests

发送 JSON 数据的 POST 请求步骤

接下来，让我们一步步看看如何发送 JSON 数据的 POST 请求。

1. 定义目标 URL

首先，需要定义你要发送请求的目标 URL：

url = 'https://httpbin.org/post'

2. 准备要发送的 JSON 数据

接下来，准备你要发送的 JSON 数据。可以使用 Python 的内置字典来表示 JSON 数据：

data = {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "age": 30
}

3. 发送 POST 请求并包含 JSON 数据

在 requests 库中，通过 post 方法可以轻松发送 POST 请求，并且可以使用 json 参数直接传递 JSON 数据：

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

4. 处理响应

一般来说，服务器会返回一个响应对象。你可以通过该对象访问响应的状态码、响应体等信息：

if response.status_code == 200:
    print('Request was successful.')
    print('Response JSON:', response.json())
else:
    print(f'Request failed with status code {response.status_code}')

至此，你已经成功使用 requests 库发送了一次包含 JSON 数据的 POST 请求。在实际应用中，你还可以结合错误处理、认证等功能来应对更复杂的请求。

一个完整的例子

为了让你更好地理解，下面是一个完整的示例代码：

import requests

# 目标 URL
url = 'https://httpbin.org/post'

# 准备 JSON 数据
data = {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "age": 30
}

try:
    # 发送 POST 请求
    response = requests.post(url, json=data)
    
    # 检查响应状态码
    if response.status_code == 200:
        print('Request was successful.')
        print('Response JSON:', response.json())
    else:
        print(f'Request failed with status code {response.status_code}')
except requests.exceptions.RequestException as e:
    print('An error occurred:', e)

如何一键发布 JSON 数据

对于需要发送 JSON 格式数据的用户来说，Apifox 提供了非常便捷的功能。用户只需在请求体（Body）部分选择 JSON 格式，无需手动设置 HTTP 头部信息，即可轻松发送 POST 请求。如下图所示，选择 “POST” 为 HTTP 方法，然后在 “Body” 选项卡中选择 JSON 格式，即可完成设置并发送请求。

自动生成 Python 请求代码的功能

此外，Apifox 提供一个非常实用的特性——自动生成 Python 代码。这一功能尤其适合不希望花时间手动编写代码的开发者。通过简单的设置，您可以快速获取可用的请求实现代码。

操作步骤一：在 Apifox 中找到您之前保存的 API 请求，移动鼠标到右侧面板的“生成接口请求代码”，然后点击生成客户端代码。

操作步骤二：在弹出的代码生成窗口中选择 “Python” 和 “Requests”，系统会自动为您生成基于 Requests 库的 Python 代码。

总结

使用 requests 库发送 JSON 数据的 POST 请求是一个非常简单且实用的操作。通过将目标 URL 和 JSON 数据传递给 requests.post 方法，你可以轻松发送请求并处理响应。本篇文章介绍了从安装 requests 库，到发送 JSON 数据的 POST 请求，再到处理响应的整个流程。希望这篇文章能帮助你更好地理解并应用这个强大的 HTTP 请求库。

作者：Apifox
链接：https://juejin.cn/post/7379896952040325146