python - 为什么 HTTP POST 请求正文需要在 Python 中进行 JSON 编码？

Question

我在使用外部 API 时遇到了这个问题。我将我的 body 数据作为字典直接发送到请求中，并收到 400 个错误:

data = {
  "someParamRange": {
    "to": 1000, 
    "from": 100
  }, 
  "anotherParamRange": {
    "to": True, 
    "from": False
  }
}

当我添加一个 json.dumps 包装时，它可以工作:

data = json.dumps({
  "someParamRange": {
    "to": 1000, 
    "from": 100
  }, 
  "anotherParamRange": {
    "to": True, 
    "from": False
  }
})

我不完全理解为什么这是必要的，因为字典和 JSON 对象在语法上是相同的。有人可以帮我了解这里的幕后情况吗？

为了完整起见，这是我的标题:

headers = {'API-KEY': 'blerg', 'Accept-Encoding': 'UTF-8', 'Content-Type': 'application/json', 'Accept': '*/*', 'username': 'user', 'password': 'pwd'}

编辑:

我之前没有提到这一点，但现在我觉得它可能是相关的。我正在使用 Python Requests 库，另一篇文章似乎建议您永远不必将参数编码为请求对象:https://stackoverflow.com/a/14804320/1012040

“无论是 GET/POST，您都无需再次对参数进行编码，它只需将字典作为参数即可。”

好像不需要序列化？

我的请求对象:

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

Answer 1

显然，您的 API 需要 JSON 编码而非表单编码的数据。当您将 dict 作为 data 参数传入时，数据将被表单编码。当你传递一个字符串时(如 json.dumps 的结果)，数据不是表单编码的。

考虑一下请求文档中的这句话:

Typically, you want to send some form-encoded data — much like an HTML form. To do this, simply pass a dictionary to the data argument. Your dictionary of data will automatically be form-encoded when the request is made.

There are many times that you want to send data that is not form-encoded. If you pass in a string instead of a dict, that data will be posted directly.

For example, the GitHub API v3 accepts JSON-Encoded POST/PATCH data:

>>> import json
>>> url = 'https://api.github.com/some/endpoint'
>>> payload = {'some': 'data'}

>>> r = requests.post(url, data=json.dumps(payload))

引用:

• http://www.w3.org/TR/html401/interact/forms.html#h-17.13.3.4
• http://docs.python-requests.org/en/latest/user/quickstart/#more-complicated-post-requests