使用CPR库向FastAPI服务器发送JSON数据的正确方法

在开发基于C++的客户端与FastAPI服务器交互时，正确发送JSON数据是一个常见的技术挑战。本文将详细介绍如何使用CPR库（C++ Requests库）向FastAPI服务器发送JSON格式的数据。

问题背景

当开发者尝试使用CPR库向FastAPI服务器发送POST请求时，经常会遇到JSON解析错误。这通常是由于数据格式不正确或内容类型设置不当导致的。

正确实现方法

1. 服务器端代码

首先，我们来看FastAPI服务器的Python代码示例：

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    vorname: str
    nachname: str | None = None
    alter: int
    gewicht: float | None = None

@app.post("/items/")
async def create_item(item: Item):
    return item

这个API端点期望接收一个符合Item模型的JSON对象。

2. 客户端实现

在C++客户端中，使用CPR库发送请求的正确方式如下：

#include <iostream>
#include <cpr/cpr.h>

int main() {
    cpr::Response postRequest = cpr::Post(
        cpr::Url{"http://127.0.0.1:8000/items"},
        cpr::Header{{"Content-Type", "application/json"}},
        cpr::Body{R"({ "vorname": "Olaf", "nachname": "Ralf", "alter": 42, "gewicht": 24 })"}
    );
    std::cout << postRequest.text << std::endl;
    return 0;
}

关键点说明

1. 内容类型头：必须设置Content-Type为application/json，这是告诉服务器我们发送的是JSON格式的数据。

2. JSON格式：使用原始字符串字面量（R前缀）可以避免转义引号带来的麻烦，保持JSON格式的清晰。

3. 数据类型匹配：确保发送的数据类型与服务器端模型定义一致：

   • alter应为整数（不带引号）
   • gewicht应为浮点数或整数（不带引号）
   • 字符串值必须用双引号括起来

常见错误及解决方案

1. JSON解析错误：通常是因为JSON格式不正确，如缺少大括号或引号不匹配。

2. 数据类型不匹配：例如将数字值用引号括起来发送为字符串，而服务器期望的是数值类型。

3. 内容类型未设置：忘记设置Content-Type头或设置为错误的值（如text/plain）。

最佳实践建议

1. 在C++中使用原始字符串字面量（R"()"）来定义JSON数据，可以避免转义字符带来的混乱。

2. 在开发过程中，可以使用工具如Postman先测试API接口，确保服务器端正常工作后再实现客户端代码。

3. 考虑使用JSON库（如nlohmann/json）来构建和验证JSON数据，而不是手动拼接字符串。

通过遵循这些指导原则，开发者可以确保C++客户端与FastAPI服务器之间的JSON数据交互顺利进行。