json-schema-codegen
Generate code from JSON schema files.
Table of contents
- Introduction
- Currently supported languages
- Requirements
- Installation
- Usage
- Code generation
- Contribute
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:
- generate the AST for the target language from the
json-schemafile - 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 2.7+
- JavaScript ES7+ with Flow annotations
- pure Flow annotations
Requirements
- Python 3.x
- Node v8.4+
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 2
The generation of Python's code is integrated into the tool so it needs just a single invocation:
json_codegen --language python --output <output_py_file> <json-schema>
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>
3 Aug 08, 2022
3 Feb 05, 2022
2 Feb 02, 2022
0 Jan 22, 2022
4 Jan 01, 2022
1 Oct 14, 2021
2 Feb 02, 2022
2 Oct 19, 2022
235 Dec 29, 2022
3.4k Dec 29, 2022
2 Feb 10, 2022
14 Dec 22, 2022
1 Jan 07, 2022
4 Sep 19, 2022
44 Dec 29, 2022
12.6k Dec 30, 2022
3 Jan 09, 2022
5 Dec 01, 2021
4 Mar 22, 2022
4 Apr 24, 2022