specta-jsonschema 0.0.3

Export your Rust types to a JSON Schema
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

#![allow(clippy::unwrap_used, missing_docs)]

use std::fs;

use serde::{Deserialize, Serialize};
use specta::{Type, Types};
use specta_jsonschema::{JsonSchema, SchemaVersion};

#[derive(Serialize, Deserialize, Type)]
struct User {
    id: u32,
    name: String,
    email: Option<String>,
}

#[derive(Serialize, Deserialize, Type)]
enum Status {
    Active,
    Inactive,
    Pending,
}

#[test]
fn test_basic_export() {
    let types = Types::default().register::<User>().register::<Status>();

    let result = JsonSchema::default().export(&types, specta_serde::Format);
    assert!(result.is_ok(), "Export should succeed: {:?}", result.err());

    let schema_str = result.unwrap();
    assert!(schema_str.contains("\"$schema\""));
    assert!(schema_str.contains("\"User\""));
    assert!(schema_str.contains("\"Status\""));
}

#[test]
fn test_schema_version() {
    let types = Types::default().register::<User>();

    let result = JsonSchema::default()
        .schema_version(SchemaVersion::Draft7)
        .export(&types, specta_serde::Format);

    assert!(result.is_ok());
    let schema = result.unwrap();
    assert!(schema.contains("http://json-schema.org/draft-07/schema#"));
}

#[test]
fn test_primitives() {
    #[derive(Serialize, Deserialize, Type)]
    struct Primitives {
        string_field: String,
        int_field: i32,
        float_field: f64,
        bool_field: bool,
    }

    let types = Types::default().register::<Primitives>();
    let result = JsonSchema::default().export(&types, specta_serde::Format);

    assert!(result.is_ok());
    let schema = result.unwrap();
    assert!(schema.contains("Primitives"));
}

#[test]
fn test_nullable() {
    let types = Types::default().register::<User>();
    let result = JsonSchema::default().export(&types, specta_serde::Format);

    assert!(result.is_ok());
    let schema = result.unwrap();
    // email is Option<String> so should have anyOf with null
    assert!(schema.contains("anyOf") || schema.contains("null"));
}

#[test]
fn test_enum() {
    let types = Types::default().register::<Status>();
    let result = JsonSchema::default().export(&types, specta_serde::Format);

    assert!(result.is_ok());
    let schema = result.unwrap();
    assert!(schema.contains("\"Active\""));
    assert!(schema.contains("\"Inactive\""));
    assert!(schema.contains("\"Pending\""));
}

#[test]
fn test_export_uses_format() {
    #[derive(Type, serde::Serialize)]
    #[serde(rename_all = "camelCase")]
    struct SerdeUser {
        user_id: u32,
    }

    let types = Types::default().register::<SerdeUser>();
    let schema = JsonSchema::default()
        .export(&types, specta_serde::Format)
        .unwrap();

    assert!(schema.contains("userId"));
    assert!(!schema.contains("user_id"));
}

#[test]
fn test_export_to_uses_format() {
    #[derive(Type, serde::Serialize)]
    #[serde(rename_all = "camelCase")]
    struct SerdeUser {
        user_id: u32,
    }

    let types = Types::default().register::<SerdeUser>();
    let path = std::path::Path::new(env!("CARGO_MANIFEST_DIR"))
        .join("target")
        .join(format!("jsonschema-test-{}.json", std::process::id()));

    JsonSchema::default()
        .export_to(&path, &types, specta_serde::Format)
        .unwrap();

    let schema = fs::read_to_string(&path).unwrap();
    fs::remove_file(&path).unwrap();

    assert!(schema.contains("userId"));
    assert!(!schema.contains("user_id"));
}