Skip to content

michiel/jsonapi-rust

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

jsonapi-rust

Build Status Crates.io Status License Documentation FOSSA Status

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

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

FOSSA Status

About

Rust library for serialization, deserialization and working with JSON-API data

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages