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:

```rust use exonumapi::{ApiBuilder}; use serdederive::{Deserialize, Serialize};

[derive(Serialize, Deserialize)]

pub struct SomeQuery { pub first: u64, pub second: u64, }

fn createapi() -> ApiBuilder { let mut builder = ApiBuilder::new(); builder .publicscope() .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:

toml [dependencies] exonum-api = "1.0.0-rc.2"

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

Known Issues

Server Restart on Windows

The server restart after the set of endpoints is updated seems to be broken in some Windows environments. The restart process hangs up, and the HTTP server becomes unresponsive.

License

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