This is an implementation of the JSON-API v1 specification at jsonapi.org.
Add this crate to your Cargo.toml file,
[dependencies]
jsonapi = "*"
Or use the master branch directly from github,
[dependencies]
jsonapi = { git = "https://github.com/michiel/jsonapi-rust", branch = "master" }
Examples of most serialization and deserialization cases can be found in the tests/ directory or the documentation.
The command cargo test
will run all tests. For more verbose output or output with cargo watch,
RUST_BACKTRACE=1 cargo test -- --nocapture
RUST_BACKTRACE=1 cargo watch "test -- --nocapture"
Contributions are welcome. Please add tests and write commit messages using
using conventional format. The Changelog is updated using the clog tool. The configuration is found in .clog.toml
.
The current configuration works for commit messages prefixed with feat:
, bug:
, test:
, doc:
and refactor:
.