README.md

HTTP API engine for Exonum

exonum-api crate provides an extensible interface for building backend-agnostic HTTP APIs. Within Exonum, this crate is used by Rust services and in plugins for the Exonum node.

Under the hood exonum-api uses actix.

Consult the crate docs for more details.

Examples

Providing HTTP API for a plugin:

use exonum_api::{ApiBuilder};
use serde_derive::{Deserialize, Serialize};

#[derive(Serialize, Deserialize)]
pub struct SomeQuery {
    pub first: u64,
    pub second: u64,
}

fn create_api() -> ApiBuilder {
    let mut builder = ApiBuilder::new();
    builder
        .public_scope()
        .endpoint("some", |query: SomeQuery| {
            Ok(query.first + query.second)
        });
    builder
}

let builder = create_api();
// `builder` can now be passed to the node via plugin interface
// or via node channel.

Usage

Include exonum-api as a dependency in your Cargo.toml:

[dependencies]
exonum-api = "1.0.0"

Note that the crate rarely needs to be imported directly; it is re-exported by the exonum crate.

License

exonum-api is licensed under the Apache License (Version 2.0). See LICENSE for details.