1 unstable release

0.1.0 Nov 6, 2022

#16 in #programmatically

Download history 21/week @ 2024-11-13 46/week @ 2024-11-20 95/week @ 2024-11-27 92/week @ 2024-12-04 75/week @ 2024-12-11 46/week @ 2024-12-18 5/week @ 2024-12-25 23/week @ 2025-01-01 35/week @ 2025-01-08 56/week @ 2025-01-15 53/week @ 2025-01-22 32/week @ 2025-01-29 45/week @ 2025-02-05 41/week @ 2025-02-12 39/week @ 2025-02-19 41/week @ 2025-02-26

173 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

~8MB
~202K SLoC