Rust library for serialization, deserialization and working with JSON-API data
Rust
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
data
src
tests
.clog.toml
.gitignore
.travis.yml
CHANGELOG.md
Cargo.toml
LICENSE
README.md

README.md

jsonapi-rust

Build Status codecov Crates.io Status License Documentation

This is an implementation of the JSON-API v1 specification at jsonapi.org.

Use

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.

Development

Testing

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"

Contributing

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:.