4 releases (1 stable)

1.0.0 Mar 31, 2020
1.0.0-rc.3 Mar 25, 2020
1.0.0-rc.2 Mar 13, 2020
1.0.0-rc.1 Feb 7, 2020

#15 in #exonum

Download history 53/week @ 2024-02-26 34/week @ 2024-03-04 32/week @ 2024-03-11 44/week @ 2024-03-18 52/week @ 2024-03-25 76/week @ 2024-04-01 28/week @ 2024-04-08 33/week @ 2024-04-15 38/week @ 2024-04-22 32/week @ 2024-04-29 49/week @ 2024-05-06 38/week @ 2024-05-13 42/week @ 2024-05-20 23/week @ 2024-05-27 24/week @ 2024-06-03 30/week @ 2024-06-10

126 downloads per month
Used in 11 crates (6 directly)

Apache-2.0

58KB
1K SLoC

HTTP API engine for Exonum

Travis Build Status License: Apache-2.0 rust 1.42.0+ required

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.

Dependencies

~27MB
~569K SLoC