#json-schema #schema-validation #validation #draft #regex #uri #format

boon

JSONSchema (draft 2020-12, draft 2019-09, draft-7, draft-6, draft-4) Validation

12 releases

0.6.0 May 30, 2024
0.5.3 Jan 27, 2024
0.5.1 Jul 13, 2023
0.5.0 Mar 28, 2023
0.1.1 Feb 17, 2023

#228 in Web programming

Download history 861/week @ 2024-03-14 947/week @ 2024-03-21 908/week @ 2024-03-28 1006/week @ 2024-04-04 1070/week @ 2024-04-11 937/week @ 2024-04-18 1186/week @ 2024-04-25 1068/week @ 2024-05-02 1257/week @ 2024-05-09 814/week @ 2024-05-16 746/week @ 2024-05-23 991/week @ 2024-05-30 938/week @ 2024-06-06 981/week @ 2024-06-13 1462/week @ 2024-06-20 1241/week @ 2024-06-27

4,716 downloads per month
Used in 2 crates

MIT/Apache

200KB
5K SLoC

License Crates.io docs.rs Build Status codecov dependency status

Examples Changelog

Library Features

  • pass JSON-Schema-Test-Suite excluding optional(compare with other impls at bowtie)
    • draft-04
    • draft-06
    • draft-07
    • draft/2019-09
    • draft/2020-12
  • detect infinite loop traps
    • $schema cycle
    • validation cycle
  • custom $schema url
  • vocabulary based validation
  • ECMA-262 regex compatibility (pass tests from optional/ecmascript-regex.json)
  • format assertions
    • flag to enable in draft >= 2019-09
    • custom format registration
    • built-in formats
      • regex, uuid
      • ipv4, ipv6
      • hostname, email
      • idn-hostname, idn-email
      • date, time, date-time, duration
      • json-pointer, relative-json-pointer
      • uri, uri-reference, uri-template
      • iri, iri-reference
      • period
  • content assertions
    • flag to enable in draft >= 7
    • contentEncoding
      • base64
      • custom
    • contentMediaType
      • application/json
      • custom
    • contentSchema
  • errors
    • introspectable
    • hierarchy
      • alternative display with #
    • output
      • flag
      • basic
      • detailed
  • custom vocabulary

CLI

to install: cargo install boon-cli

or download it from releases

Usage: boon [OPTIONS] SCHEMA [INSTANCE...]

Options:
    -h, --help          Print help information
    -q, --quiet         Do not print errors
    -d, --draft <VER>   Draft used when '$schema' is missing. Valid values 4,
                        6, 7, 2019, 2020 (default 2020)
    -o, --output <FMT>  Output format. Valid values simple, alt, flag, basic,
                        detailed (default simple)
    -f, --assert-format
                        Enable format assertions with draft >= 2019
    -c, --assert-content
                        Enable content assertions with draft >= 7
        --cacert <FILE> Use the specified PEM certificate file to verify the
                        peer. The file may contain multiple CA certificates
    -k, --insecure      Use insecure TLS connection

This cli can validate both schema and multiple instances.

It support both json and yaml files

exit code is:

  • 1 if command line arguments are invalid.
  • 2 if there are errors

Dependencies

~4.5–6.5MB
~138K SLoC