No Description

Milo Yip 1a803826f1 Merge pull request #1720 from madeso/master 1 week ago
CMakeModules ce3ca58fee Change googletest search path for cmake 4 years ago
bin 38d25d7458 Fix FileReadStream::Peek4(). 1 year ago
contrib 36481c30b3 Update Visual Studio Visualizer (#1665) 1 month ago
doc d4f03d0d04 Doc: Fix some typos. (#1675) 1 month ago
docker 680c111278 Add debian docker file for development 4 years ago
example dfbe1db9da Merge pull request #1502 from ylavic/compilation_fixes 5 months ago
include ac0fc79c76 Fixes issue #1718 1 week ago
test a895ce150f Allow escaped apostrophe in values (#1639) 3 months ago
thirdparty fdd2db930f Updated google test to latest commit 1 year ago
.gitattributes a62777487d Normalize line endings but not JSON files 4 years ago
.gitignore 25c1b78f3c ignore DS_Store files 2 years ago
.gitmodules 47d7320096 Update reference to gtest thirdparty module. 4 years ago
.travis.yml 234ff044f4 ci: upgrade distro to xenial and add arm64 test cases (#1662) 1 month ago 8684c9960d fix some typos 2 years ago
CMakeLists.txt 46d980b46a fix CMake policy CMP0048 warning #1154 6 months ago 4a2f2729f1 Change from miloyip/rapidjson to Tencent/rapidjson 2 years ago 1ce28f454b Add CMake minimum version required. 1 month ago 8ae1c971ea Add initial CMake support 5 years ago
appveyor.yml a6be583efa Update appveyor rule to support VS2017. 1 year ago
include_dirs.js f8df637783 include folder added 4 years ago
library.json 4a2f2729f1 Change from miloyip/rapidjson to Tencent/rapidjson 2 years ago
license.txt a62777487d Normalize line endings but not JSON files 4 years ago
package.json 4a2f2729f1 Change from miloyip/rapidjson to Tencent/rapidjson 2 years ago
rapidjson.autopkg 915218878a Misc. typos 2 years ago b4cf6e7381 Add vcpkg installation instructions 4 months ago 2a0bc6062b Update gitbook zh-cn link 2 years ago 02d4ae838c Update 8 months ago

RapidJSON logo

Release version

A fast JSON parser/generator for C++ with both SAX/DOM style API

Tencent is pleased to support the open source community by making RapidJSON available.

Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip. All rights reserved.

Build status

Linux Windows Coveralls
lin-badge win-badge cov-badge


RapidJSON is a JSON parser and generator for C++. It was inspired by RapidXml.

  • RapidJSON is small but complete. It supports both SAX and DOM style API. The SAX parser is only a half thousand lines of code.

  • RapidJSON is fast. Its performance can be comparable to strlen(). It also optionally supports SSE2/SSE4.2 for acceleration.

  • RapidJSON is self-contained and header-only. It does not depend on external libraries such as BOOST. It even does not depend on STL.

  • RapidJSON is memory-friendly. Each JSON value occupies exactly 16 bytes for most 32/64-bit machines (excluding text string). By default it uses a fast memory allocator, and the parser allocates memory compactly during parsing.

  • RapidJSON is Unicode-friendly. It supports UTF-8, UTF-16, UTF-32 (LE & BE), and their detection, validation and transcoding internally. For example, you can read a UTF-8 file and let RapidJSON transcode the JSON strings into UTF-16 in the DOM. It also supports surrogates and "\u0000" (null character).

More features can be read here.

JSON(JavaScript Object Notation) is a light-weight data exchange format. RapidJSON should be in full compliance with RFC7159/ECMA-404, with optional support of relaxed syntax. More information about JSON can be obtained at

Highlights in v1.1 (2016-8-25)

For other changes please refer to change log.


RapidJSON is cross-platform. Some platform/compiler combinations which have been tested are shown as follows.

  • Visual C++ 2008/2010/2013 on Windows (32/64-bit)
  • GNU C++ 3.8.x on Cygwin
  • Clang 3.4 on Mac OS X (32/64-bit) and iOS
  • Clang 3.4 on Android NDK

Users can build and run the unit tests on their platform/compiler.


RapidJSON is a header-only C++ library. Just copy the include/rapidjson folder to system or project's include path.

Alternatively, if you are using the vcpkg dependency manager you can download and install rapidjson with CMake integration in a single command:

  • vcpkg install rapidjson

RapidJSON uses following software as its dependencies:

  • CMake as a general build tool
  • (optional) Doxygen to build documentation
  • (optional) googletest for unit and performance testing

To generate user documentation and run tests please proceed with the steps below:

  1. Execute git submodule update --init to get the files of thirdparty submodules (google test).
  2. Create directory called build in rapidjson source directory.
  3. Change to build directory and run cmake .. command to configure your build. Windows users can do the same with cmake-gui application.
  4. On Windows, build the solution found in the build directory. On Linux, run make from the build directory.

On successful build you will find compiled test and example binaries in bin directory. The generated documentation will be available in doc/html directory of the build tree. To run tests after finished build please run make test or ctest from your build tree. You can get detailed output using ctest -V command.

It is possible to install library system-wide by running make install command from the build tree with administrative privileges. This will install all files according to system preferences. Once RapidJSON is installed, it is possible to use it from other CMake projects by adding find_package(RapidJSON) line to your CMakeLists.txt.

Usage at a glance

This simple example parses a JSON string into a document (DOM), make a simple modification of the DOM, and finally stringify the DOM to a JSON string.

// rapidjson/example/simpledom/simpledom.cpp`
#include "rapidjson/document.h"
#include "rapidjson/writer.h"
#include "rapidjson/stringbuffer.h"
#include <iostream>

using namespace rapidjson;

int main() {
    // 1. Parse a JSON string into DOM.
    const char* json = "{\"project\":\"rapidjson\",\"stars\":10}";
    Document d;

    // 2. Modify it by DOM.
    Value& s = d["stars"];
    s.SetInt(s.GetInt() + 1);

    // 3. Stringify the DOM
    StringBuffer buffer;
    Writer<StringBuffer> writer(buffer);

    // Output {"project":"rapidjson","stars":11}
    std::cout << buffer.GetString() << std::endl;
    return 0;

Note that this example did not handle potential errors.

The following diagram shows the process.


More examples are available:



    • simplereader: Dumps all SAX events while parsing a JSON by Reader.
    • condense: A command line tool to rewrite a JSON, with all whitespaces removed.
    • pretty: A command line tool to rewrite a JSON with indents and newlines by PrettyWriter.
    • capitalize: A command line tool to capitalize strings in JSON.
    • messagereader: Parse a JSON message with SAX API.
    • serialize: Serialize a C++ object into JSON with SAX API.
    • jsonx: Implements a JsonxWriter which stringify SAX events into JSONx (a kind of XML) format. The example is a command line tool which converts input JSON into JSONx format.
  • Schema

    • schemavalidator : A command line tool to validate a JSON with a JSON schema.
  • Advanced

    • prettyauto: A modified version of pretty to automatically handle JSON with any UTF encodings.
    • parsebyparts: Implements an AsyncDocumentParser which can parse JSON in parts, using C++11 thread.
    • filterkey: A command line tool to remove all values with user-specified key.
    • filterkeydom: Same tool as above, but it demonstrates how to use a generator to populate a Document.


RapidJSON welcomes contributions. When contributing, please follow the code below.


Feel free to submit issues and enhancement requests.

Please help us by providing minimal reproducible examples, because source code is easier to let other people understand what happens. For crash problems on certain platforms, please bring stack dump content with the detail of the OS, compiler, etc.

Please try breakpoint debugging first, tell us what you found, see if we can start exploring based on more information been prepared.


In general, we follow the "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Checkout a new branch on your fork, start developing on the branch
  4. Test the change before commit, Make sure the changes pass all the tests, including unittest and preftest, please add test case for each new feature or bug-fix if needed.
  5. Commit changes to your own branch
  6. Push your work back up to your fork
  7. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Copyright and Licensing

You can copy and paste the license summary from below.

Tencent is pleased to support the open source community by making RapidJSON available.

Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip. All rights reserved.

Licensed under the MIT License (the "License"); you may not use this file except
in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed 
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR 
CONDITIONS OF ANY KIND, either express or implied. See the License for the 
specific language governing permissions and limitations under the License.