generic-library/valijson
1
0
Fork 0
mirror of https://github.com/tristanpenman/valijson.git synced 2024-12-13 10:32:58 +01:00
Code Issues Projects Releases Wiki Activity
7a6d22ebeb
valijson/README.md

67 lines
2.5 KiB
Markdown
Raw Normal View History

Add CMake and travis configuration files for automated builds.
2014-04-17 02:58:51 +02:00
Valijson [![Build Status](https://travis-ci.org/tristanpenman/valijson.svg?branch=master)](https://travis-ci.org/tristanpenman/valijson)
Initial commit. This commit contains the third major design of a C++ library for JSON Schema validation. It is definitely not what I would consider production-ready, but I do think that the overall design of the library is robust.
2013-10-29 21:51:11 +01:00
========
Overview
--------
Update requirements in README file, add make wrapping more consistent.
2014-02-28 22:59:43 +01:00
Valijson is a header-only [JSON Schema](http://json-schema.org/) Validation library for C++.
Initial commit. This commit contains the third major design of a C++ library for JSON Schema validation. It is definitely not what I would consider production-ready, but I do think that the overall design of the library is robust.
2013-10-29 21:51:11 +01:00
Update requirements in README file, add make wrapping more consistent.
2014-02-28 22:59:43 +01:00
Valijson provides a simple validation API that allows you load JSON Schemas, and validate documents loaded by one of several supported parser libraries.
Initial commit. This commit contains the third major design of a C++ library for JSON Schema validation. It is definitely not what I would consider production-ready, but I do think that the overall design of the library is robust.
2013-10-29 21:51:11 +01:00
License
-------
Valijson is licensed under the Simplified BSD License. See the LICENSE file
for more information.
Dependencies
------------
Required:
Update requirements in README file, add make wrapping more consistent.
2014-02-28 22:59:43 +01:00
- boost 1.54
Valijson supports JSON documents loaded using JsonCpp, RapidJson and Boost Property Tree. It has been tested against the following versions of these libraries:
- [boost::property\_tree 1.54](http://www.boost.org/doc/libs/1_54_0/doc/html/boost_propertytree/synopsis.html)
- [jsoncpp 0.5.0](http://downloads.sourceforge.net/project/jsoncpp/jsoncpp/0.5.0/jsoncpp-src-0.5.0.tar.gz)
- [rapidjson 0.1](https://code.google.com/p/rapidjson/downloads/detail?name=rapidjson-0.1.zip)
Other versions of these libraries may work, but have not been tested.
Initial commit. This commit contains the third major design of a C++ library for JSON Schema validation. It is definitely not what I would consider production-ready, but I do think that the overall design of the library is robust.
2013-10-29 21:51:11 +01:00
JSON Schema Support
-------------------
Update requirements in README file, add make wrapping more consistent.
2014-02-28 22:59:43 +01:00
Valijson supports most of the constraints defined in [Draft 3](http://tools.ietf.org/search/draft-zyp-json-schema-03) and [Draft 4](http://tools.ietf.org/search/draft-zyp-json-schema-04) of the JSON Schema specification.
Initial commit. This commit contains the third major design of a C++ library for JSON Schema validation. It is definitely not what I would consider production-ready, but I do think that the overall design of the library is robust.
2013-10-29 21:51:11 +01:00
The exceptions for Draft 3 are:
Update requirements in README file, add make wrapping more consistent.
2014-02-28 22:59:43 +01:00
Initial commit. This commit contains the third major design of a C++ library for JSON Schema validation. It is definitely not what I would consider production-ready, but I do think that the overall design of the library is robust.
2013-10-29 21:51:11 +01:00
- disallow
- divisibleBy
- extends
- format (optional)
- readonly
- ref
- refRemote
The exceptions for Draft 4 are:
Update requirements in README file, add make wrapping more consistent.
2014-02-28 22:59:43 +01:00
Initial commit. This commit contains the third major design of a C++ library for JSON Schema validation. It is definitely not what I would consider production-ready, but I do think that the overall design of the library is robust.
2013-10-29 21:51:11 +01:00
- definitions
- format (optional)
- multipleOf
- ref
- refRemote
Support for JSON References is in development.
Build instructions
------------------
Update requirements in README file, add make wrapping more consistent.
2014-02-28 22:59:43 +01:00
A rudimentary Makefile has been included. Running 'make examples' will build the example programs in the 'examples' directory. Running 'make check' will build and run the test suite. Executables will be placed in 'bin'.
Initial commit. This commit contains the third major design of a C++ library for JSON Schema validation. It is definitely not what I would consider production-ready, but I do think that the overall design of the library is robust.
2013-10-29 21:51:11 +01:00
Update requirements in README file, add make wrapping more consistent.
2014-02-28 22:59:43 +01:00
An Xcode 5 project has also been provided, in the 'xcode' directory. Note that in order to run the test suite, you may need to configure the working directory for the 'test\_suite' scheme.
Initial commit. This commit contains the third major design of a C++ library for JSON Schema validation. It is definitely not what I would consider production-ready, but I do think that the overall design of the library is robust.
2013-10-29 21:51:11 +01:00
Update requirements in README file, add make wrapping more consistent.
2014-02-28 22:59:43 +01:00
The Xcode project has been configured so that /usr/local/include is in the include path, and /usr/local/lib is in the library path. These are the locations that homebrew installed Boost on my test system.
Initial commit. This commit contains the third major design of a C++ library for JSON Schema validation. It is definitely not what I would consider production-ready, but I do think that the overall design of the library is robust.
2013-10-29 21:51:11 +01:00
Update requirements in README file, add make wrapping more consistent.
2014-02-28 22:59:43 +01:00
Doxygen documentation can be built by running 'doxygen' from the project root directory. Generated documentation will be placed in 'doc/html'. Other relevant documentation such as schemas and specifications have been included in the 'doc' directory.
Reference in New Issue Copy Permalink