quick-type-schema 0.1.0

Generate json schema and language bindings
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

# `quick-type-schema`

[![Version Badge](https://img.shields.io/crates/v/quick-type-schema)](https://crates.io/crates/quick-type-schema)
[![Docs Badge](https://img.shields.io/docsrs/quick-type-schema/latest)](https://docs.rs/quick-type-schema/latest/quick-type-schema/)
[![License Badge](https://img.shields.io/crates/l/quick-type-schema)](LICENSE)
[![Downloads Badge](https://img.shields.io/crates/d/quick-type-schema)](https://crates.io/crates/quick-type-schema)

`quick-type-schema` is a simple library that takes your rust types and converts them to whatever language by converting your types into JSON schema, then running it through [quicktype.io](quicktype.io).
Created for [`bubbel-backend`](https://github.com/joinbubbel/bubbel-backend), this library has been repurposed for the general use case!

> To be 100% clear, this library is a wrapper over [quicktype.io](quicktype.io).

## Prerequisites

Since this library is a wrapper over quicktype, you will need either `npx` or `quicktype` installed.
The latter will startup faster.

Additionally, you will need the `JsonSchema` trait from [`schema-rs`](https://github.com/GREsau/schemars)
to be derived for your types.

## Usage

Add to `Cargo.toml`

```toml
[dependencies]
quick-type-schema = "0.1"
```

```rust
use quick_type_schema::{CodegenContext, Language};

// quicktype cli override arguments can be explicitly added here.
// Ex: `Some(&["-l", "typescript", "--just-types"])`
let mut codegen = CodegenContext::new(None);

// Add a type that has derived `JsonSchema`
codegen.add_type::<MyStruct>();

// Add your own json schema
codegen.add_schema("{ ... }");

codegen.finish(Language::Typescript);
```

You can add these to your build process, but because of the slow startup of quicktype and lack of caching, this is highly discouraged.

## Language Support

Generally, `quick-type-schema` supports pretty much every language quicktype supports.
However, some have been left out due to incompatibilities or complexity (notable ones being C, C++, Java, Kotlin, Objective-C, and Scala3).
For those languages, please use the override arguments and refer to the quicktype cli - `quicktype --help`.
Here are the supported languages:

```
Typescript
JsonSchema
CSharp
    +via Newton Soft
    +via System.Text.Json
Crystal
Dart
Elm
Go
Haskell
Python
    +via v3.5
    +via v3.6
    +via v3.7
Ruby
Rust
Smithy
Swift
```