json-schema-rs
A Rust library to generate Rust structs from JSON Schema.
Features
- Unsupported keys are ignored. Unknown keywords and unsupported types do not cause an error; they are skipped.
Objects
The root schema must have type: "object". Object schemas are traversed
recursively; each object with properties yields a Rust struct. Non-object
types at the root cause generation to fail.
The properties key defines the shape of each object. Each property becomes a
struct field. Property keys are sanitized for Rust (e.g. - becomes _); when
the Rust field name differs from the JSON key, generated code includes
#[serde(rename = "...")].
Nested properties produce nested structs. Child structs are emitted before
parent structs (topological order), so the generated Rust compiles without
reordering.
The title of an object schema is used as the struct name (PascalCase). If
title is missing or empty, the struct name is derived from the property key
that references it.
String type
Properties with type: "string" are emitted as String in Rust. Generated
structs use serde::Serialize and serde::Deserialize.
Enums
When a property has an enum of string values, the crate generates a Rust enum
instead of String. Variant names are PascalCase. If multiple JSON values map
to the same variant name (e.g. "PENDING" and "pending"), suffixes like _0,
_1 are applied so variant names stay unique.
Required vs Optional
The required array lists property names that are required at that object
level. Required properties are emitted as T; others as Option<T>. If
required is absent, all properties are treated as optional.
Unsupported features
| Feature | Description |
|---|---|
type: "array" + items |
Would generate Vec<T> |
type: "boolean" |
Would generate bool |
type: "number" / type: "integer" |
Would generate f64 / i64 (or configurable) |
$ref / definitions / $defs |
Schema reuse and shared types |
additionalProperties |
Would generate BTreeMap<String, T> for map-like objects |
minLength / maxLength / pattern |
String validation or custom deserialization |
default |
Would enable #[serde(default)] or literal defaults |
description |
Would emit /// doc comments |
format (e.g. uuid4) |
Would generate Uuid or validation |
oneOf / anyOf / allOf |
Composition; enum or flattened structs |
optional |
Non-standard; similar to omitting from required |
$id |
Schema identification/referencing |
examples |
Documentation/tests |
const |
Single allowed value |
not |
Exclusion |
minProperties / maxProperties |
Object size constraints |
minItems / maxItems / uniqueItems |
Array constraints |
exclusiveMinimum / exclusiveMaximum / multipleOf |
Number constraints |
readOnly / writeOnly / deprecated |
Metadata |
propertyNames / additionalItems |
Object/array constraints |
minimum / maximum |
Number bounds |
null type / type array |
Multiple types |
Examples
JSON Schema:
Generated Rust:
//! Generated by json-schema-rs. Do not edit manually.
use ;
View full example in examples/readme_example.rs
Running the binary
The crate includes a CLI binary json-schema-gen that reads a JSON Schema from
stdin and writes generated Rust code to stdout.
Build the binary:
The binary is at target/release/json-schema-gen.
Run it:
Or pipe from another command:
|
Alternative libraries
TODO
Developers
Project is under active maintenance - even if there are no recent commits! Please submit an issue / bug request if the library needs updating for any reason!
Philosophy
- Generates idiomatic Rust
- Can handle every JSON Schema specification version
Commands
make lintmake testmake fix
Credits
Made by Todd Everett Griffin.