CLI for generation of type definitions for Rust, Kotlin, TypeScript and JSON Schema from JSON
Note: There is also a web interface, and for Rust types there is also a procedural macro interface to this code, which uses the same underlying algorithm and code generation. See the repository for details and typegen.vestera.as for the web interface.
Installation
Install with cargo
:
# installed binary is called json_typegen
# make sure ~/.cargo/bin is on your PATH
Or download precompiled binaries from the GitHub releases page.
Usage
To generate the Rust type Point
in point.rs
from a local sample, run:
Note: The output file (e.g. src/point.rs
) will be overwritten if it exists.
For an online sample, run:
The generated code assumes the availability of serde
and serde_derive
, so
make sure your Cargo.toml
contains something like:
[]
= "1.0"
= "1.0"
# Not required for the types themselves, but you probably also want:
= "1.0"
Options and configurations
For help with the CLI itself run json_typegen -h
. To configure visibility and
other options see the general configuration documentation.
Other languages
You can output code for other languages with the --output-mode
option. From --help
:
-O, --output-mode <output-mode> What to output. [possible values: rust, typescript, typescript/typealias, kotlin,
kotlin/jackson, kotlin/kotlinx, json_schema, shape]