Skip to main content

Generate code from JSON schema files.

Project description

Build Status

json-schema-codegen

Generate code from JSON schema files.

Table of contents

Introduction

This is a command line tool to take a json-schema file and generate code automatically.

For instance this json-schema definition:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Test",
  "type": "object",
  "properties": {
    "id": { "type": "integer" }
  }
}

will generate this Python code:

class Test(object):
    def __init__(self, data=None):
        data = data or {}

        self.id = data.get("id")

or this JavaScript+Flow code:

export class Test {
  id: ?number;

  constructor(data: Object = {}) {
    this.id = data.id;
  }
}

Currently this tool generates code for Python and JavaScript with Flow annotations but it can be extended to generate code for any language.

The code generation is divided in two stages:

  1. generate the AST for the target language from the json-schema file
  2. convert the AST into the target language

This allows the tool to be language agnostic, that is it just needs to generate the AST in JSON format for the target language and then a language specific tool will convert this AST into proper code.

Currently supported languages

List of currently supported languages:

  • Python 3.7+
  • JavaScript ES7+ with Flow annotations
  • pure Flow annotations

Requirements

  • Python 3.6 / 3.7
  • Node v12

Installation

Until this pull request in setuptools is fixed, the only way to install json-schema-codegen is to clone the repo:

git clone https://github.com/expobrain/json-schema-codegen.git

Usage

usage: json_codegen.py [-h] [--prefix PREFIX] [--language LANGUAGE]
                       [--output OUTPUT]
                       schema

positional arguments:
  schema                Definition of the PRD as JSON schema

optional arguments:
  -h, --help            show this help message and exit
  --prefix PREFIX, -p PREFIX
                        Optional prefix for generated classes
  --language LANGUAGE, -l LANGUAGE
                        Output language. Default is python
  --output OUTPUT, -o OUTPUT
                        Output filename for the generated code

Code generation

Python 3

The egenerator of pure Python 3 compatible code:

json_codegen --language python3 --output <output_py_file> <json-schema>

Python 3+Marshmallow

The generation of Python 3's code with Marshmallow support is integrated into the tool so it needs just a single invocation:

json_codegen --language python3+marshmallow --output <output_py_file> <json-schema>

JavaScript+Flow and Flow

Generating JavaScript+Flow and Flow code involves two steps, generating the AST:

json_codegen --language [javascript+flow|flow] --output <output_ast_json> <json-schema>

and generating the code from the AST:

bin/ast_to_js <output_ast_json> <output_js_file>

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_codegen-0.6.0.tar.gz (128.2 kB view details)

Uploaded Source

Built Distribution

json_codegen-0.6.0-py3-none-any.whl (134.8 kB view details)

Uploaded Python 3

File details

Details for the file json_codegen-0.6.0.tar.gz.

File metadata

  • Download URL: json_codegen-0.6.0.tar.gz
  • Upload date:
  • Size: 128.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for json_codegen-0.6.0.tar.gz
Algorithm Hash digest
SHA256 d4bfb002f54e3f908a962f32bcec7d9d8c46315a6dc676a8435f71dd107fbada
MD5 487691fbca6b7766031060701d906ba0
BLAKE2b-256 04f7178db4d0667ed93b4801b78ed64048b1aa2c211d4380fcc5c5b49bec9d6c

See more details on using hashes here.

File details

Details for the file json_codegen-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: json_codegen-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 134.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for json_codegen-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9d6bc0d1d4dd8f7ca105b3d7ccbcfae2c90fe0f4c28cf5a20fc77b353d2259cc
MD5 133b94f0ecc617a30a3eca1853a27ffc
BLAKE2b-256 229a20a7bf41d8b0ce15d61038ca1ca4db7f41761afbbac385c5dedf9df4aee4

See more details on using hashes here.

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