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

在开发RESTful API应用时，客户端与服务端之间的JSON数据交互是一个常见需求。本文将以CPR(C++ Requests Library)向FastAPI服务发送JSON数据为例，详细介绍正确的实现方法。

问题背景

当使用CPR库作为客户端向FastAPI服务发送POST请求时，开发者可能会遇到JSON解析错误。常见的错误提示如"JSON decode error"或"Expecting value"，这通常是由于JSON数据格式不正确导致的。

正确实现方式

服务端代码(FastAPI)

首先，我们来看FastAPI服务端的实现。这是一个典型的FastAPI POST接口，使用Pydantic模型来定义接收的数据结构：

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

客户端代码(CPR)

正确的CPR客户端实现应该使用原始字符串字面量(Raw string literal)来构造JSON数据，确保格式完全符合JSON标准：

#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格式：

   • 必须使用完整的大括号{}包裹整个JSON对象
   • 属性名必须用双引号括起来
   • 数值类型不应加引号(如"alter": 42正确，"alter": "42"错误)

3. CPR的Body构造：使用C++11的原始字符串字面量(R"()")可以避免转义字符带来的麻烦，保持JSON的可读性。

常见错误

1. 数值类型加引号：将数值类型如整数、浮点数用引号括起来会导致类型不匹配错误。

2. 缺少大括号：JSON对象必须用{}包裹，缺少会导致语法错误。

3. 错误的Content-Type：使用text/plain等非JSON类型会导致服务端无法正确解析。

最佳实践建议

1. 在开发过程中，可以使用Postman等工具先测试API接口，确保服务端正常工作。

2. 对于复杂的JSON结构，可以考虑使用专门的JSON库(如nlohmann/json)来构建JSON对象，再转换为字符串传递给CPR。

3. 始终验证服务端返回的状态码和响应内容，便于快速定位问题。

通过遵循这些准则，可以确保C++客户端与FastAPI服务端之间的JSON数据交互正确无误。