1 unstable release

0.0.0-alpha.0 Sep 23, 2023

#1992 in Game dev

MPL-2.0 license

9KB
65 lines

Resonite API in rust

License Crates.io Docs

WIP Rust models of Resonite's API.

Any official documentation of Resonite' API is lacking, and the API is still changing too. So this crate can't guarantee correctness.

This crate provides an example API client with the optional api_client feature.

Testing

The integration tests will contact the live API. That's why they are ignored by default.

Some of them also will require authentication.

Sadly not all the things can even be reliably tested without creating a mock API. Which in turn defeats the purpose of the tests in the first place.

Running ignored tests

Make sure that you've got:

  • an internet connection
  • a valid authentication file

Then just run the tests;

# A specific test with output logging
cargo test --all-features get_user -- --exact --ignored --nocapture
# All tests
cargo test --all-features -- --ignored

License

Note that the license is MPL-2.0 instead of the more common MIT OR Apache-2.0. A license change however can be negotiated if the Resonite team wants to use this crate or adopt this crate into a more official one with a different license.

Dependencies

~0.7–15MB
~179K SLoC