Skip to main content

Generate C++ structures from JSON-Schema

Project description

JSON-Schema Codegen

This python library consumes JSON-Schema and generates C++ code. It generates structures to hold the values defined in the schema, restricting the values according to the schema. Each structure has JSON serialization and de-serialization methods.

Supported Schema Features

A C++ class is generated for each schema node according to the schema's type property. Schemas without a type property, with the exception of combining operators *Of, are not supported.

  • type: string
    • minLength
    • maxLength
    • pattern
  • type: string with enum
  • type: integer
    • maximum
    • minimum
    • exclusiveMaximum
    • exclusiveMinimum
    • multipleOf
  • type: number
    • maximum
    • minimum
    • exclusiveMaximum
    • exclusiveMinimum
    • multipleOf
  • type: boolean
  • type: null
  • type: array
    • items
    • minItems
    • maxItems
  • type: object
    • properties
    • required
  • allOf
  • anyOf
  • oneOf

References

$ref references are supported for array items, object properties, allOf, anyOf, and oneOf. However, the caller must provide a "resolver" class which translates the reference into a class name and namespace.

C++ Requirements

  • boost (boost::optional and boost::variant among others)
  • rapidjson
  • C++11

Python Requirements

  • python 3.7
  • jinja2
  • stringcase

Installation

pip install json-schema-codegen

Usage

See example_usage.py for a more elaborate example.

import jsonschemacodegen.cpp as cpp

simpleResolver = cpp.SimpleResolver()
output_dir = "/tmp"

generator = cpp.GeneratorFromSchema(src_output_dir=output_dir,
    header_output_dir=output_dir, 
    resolver=simpleResolver,
    namespace=[],
    src_usings=[])

sampleSchema = {"type": "string"}

generator.Generate(sampleSchema, 'Example', 'example')

License

GPLv2

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

json-schema-codegen-0.0.7.tar.gz (12.2 kB view hashes)

Uploaded Source

Built Distribution

json_schema_codegen-0.0.7-py3-none-any.whl (34.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page