1 unstable release

0.1.0 Nov 6, 2022

#15 in #programmatically

Download history 44/week @ 2024-10-13 45/week @ 2024-10-20 59/week @ 2024-10-27 66/week @ 2024-11-03 15/week @ 2024-11-10 29/week @ 2024-11-17 81/week @ 2024-11-24 76/week @ 2024-12-01 97/week @ 2024-12-08 65/week @ 2024-12-15 18/week @ 2024-12-22 11/week @ 2024-12-29 34/week @ 2025-01-05 44/week @ 2025-01-12 74/week @ 2025-01-19 11/week @ 2025-01-26

164 downloads per month
Used in 24 crates (3 directly)

MIT license

23KB
348 lines

jsonref dereferences JSONSchema $ref attributes and creates a new dereferenced schema.

Dereferencing is normally done by a JSONSchema validator in the process of validation, but it is sometimes useful to do this independent of the validator for tasks like:

  • Analysing a schema programatically to see what field there are.
  • Programatically modifying a schema.
  • Passing to tools that create fake JSON data from the schema.
  • Passing the schema to form generation tools.

Example:

use serde_json::json;
use jsonref::JsonRef;

let mut simple_example = json!(
          {"properties": {"prop1": {"title": "name"},
                          "prop2": {"$ref": "#/properties/prop1"}}
          }
       );

let mut jsonref = JsonRef::new();

jsonref.deref_value(&mut simple_example).unwrap();

let dereffed_expected = json!(
    {"properties": 
        {"prop1": {"title": "name"},
         "prop2": {"title": "name"}}
    }
);
assert_eq!(simple_example, dereffed_expected)

Note: If the JSONSchema has recursive $ref only the first recursion will happen. This is to stop an infinate loop.

Dependencies

~8.5MB
~224K SLoC