jsonapi-rs

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

• API Documentation at docs.rs
• CHANGELOG

Use

Add this crate to your Cargo.toml file,

[dependencies]
jsonapi-rs = "*"

Or use the master branch directly from Gitlab,

[dependencies]
jsonapi-rs = { git = "https://gitlab.com/cloud.yantra.oss/jsonapi-rust.git", branch = "main" }

Examples of most serialization and deserialization cases can be found in the tests/ directory or the documentation.

Development

Note - Until this crate reaches v1.0.0 breaking changes that are not backwards compatible will be announced in the CHANGELOG.

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

License