RapidJSON for C++: Complete Guide with Examples

RapidJSON is a high-performance library for parsing and generating JSON in C++. Developed by Milo Yip and distributed under the MIT license, it has gained popularity due to its speed, minimal memory consumption, and full compliance with the ECMA-404 (RFC 7159) standard. Unlike many other libraries, RapidJSON has no external dependencies and can work in resource-constrained environments, including embedded systems.

Why is this library needed? JSON (JavaScript Object Notation) has become the de facto standard for data exchange between web services, configuration files, and storing structured data. In C++, where performance is critical, using a slow parser can become a bottleneck. RapidJSON solves this problem: it can process megabytes of JSON in milliseconds, using a SAX-like (streaming) API to minimize allocations and a DOM API for convenient work with the object tree. This makes it an ideal choice for high-load servers, game engines, and real-time applications.

The library supports both full JSON parsing (with validation) and a "non-sensitive" mode for speed. It can work with UTF-8, UTF-16, and UTF-32, and also provides convenient iterators and search functions. RapidJSON is actively used in projects such as MongoDB, Tencent, and many open-source solutions.

Installation

RapidJSON is a header-only library (except for optional build files). This means that to use it, you just need to copy the header files into your project and include them. However, for convenience, we will consider three main installation methods.

Method 1: Cloning the repository (recommended)

Clone the repository from GitHub and copy the include/rapidjson folder into your project.

git clone https://github.com/Tencent/rapidjson.git\n# Then copy the include/rapidjson folder into your project

Method 2: Via the vcpkg package manager

If you use vcpkg, installation is done with one command:

vcpkg install rapidjson

Method 3: Via Conan

For Conan (C/C++ package manager) users:

conan install rapidjson/1.1.0@

Including in code

After installation, add the following to your source file:

#include "rapidjson/document.h"     // for DOM API\n#include "rapidjson/writer.h"       // for writing JSON\n#include "rapidjson/stringbuffer.h" // for output buffering\n#include "rapidjson/prettywriter.h" // for formatted output\n#include "rapidjson/reader.h"       // for SAX API\n#include "rapidjson/error/en.h"     // for error handling

Quick Start: Minimal Working Example

Let's write a simple program that parses a JSON string, extracts a value, and prints it to the screen.

#include <iostream>\n#include "rapidjson/document.h"\n\nint main() {\n    // 1. JSON string to parse\n    const char* json = "{\\"project\\":\\"RapidJSON\\",\\"version\\":1.0}";\n\n    // 2. Create a DOM document\n    rapidjson::Document doc;\n    doc.Parse(json);\n\n    // 3. Check if parsing was successful\n    if (doc.HasParseError()) {\n        std::cerr << "Parse error: " \n                  << rapidjson::GetParseError_En(doc.GetParseError()) \n                  << std::endl;\n        return 1;\n    }\n\n    // 4. Extract values by keys\n    const std::string& project = doc["project"].GetString();\n    double version = doc["version"].GetDouble();\n\n    // 5. Print the result\n    std::cout << "Project: " << project << std::endl;\n    std::cout << "Version: "