1 unstable release
0.1.0 | Oct 9, 2020 |
---|
#14 in #op
21KB
274 lines
op-api-rust-sdk
Rust SDK for OP REST API
Installation
To be published to crates.io
Usage
See apis crate for all available clients. Example of getting account data:
use op_api_sdk::apis::accounts::Accounts;
use op_api_sdk::options::Options;
#[tokio::main]
async fn main() {
let options = Options::new_dev(String::from("X_API_KEY"))
.with_version("v3".to_string());
let accounts = Accounts::new(options).accounts().await.unwrap();
println!("{:?}", accounts);
}
Additional examples available in the Examples directory.
See requests for required headers.
For further reading, please see our API documentation
Developing
Few guidelines for developing this library:
- Follow Rust API Guidelines
- Keep formatting consistent by using
cargo fmt
for all changes - Use
cargo clippy --workspace --all-targets --verbose --all-features
to find possible lint errors and warnings - Always add tests to your functionality, prefer TDD. Use /tests/ folder.
- Always run tests with
cargo test
before pushing to remote - Check that you have documented all public functionality with
cargo doc --open
Running tests
Tests depend to real sandbox data.
- Register at https://op-developer.fi/developers/register
- Create an app that has access to all sandbox products (Mobility, Banking, etc)
- Run tests with
X_API_KEY=<your api key> cargo test
To enable debug logging from the library set up the RUST_LOG environment variable
export RUST_LOG=op_api_sdk=debug
Dependencies
~5–10MB
~185K SLoC