exonum-api 1.0.0

HTTP API engine of the Exonum framework
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# HTTP API engine for Exonum

[![Travis Build Status](https://img.shields.io/travis/exonum/exonum/master.svg?label=Linux%20Build)](https://travis-ci.com/exonum/exonum)
[![License: Apache-2.0](https://img.shields.io/github/license/exonum/exonum.svg)](https://github.com/exonum/exonum/blob/master/LICENSE)
![rust 1.42.0+ required](https://img.shields.io/badge/rust-1.42.0+-blue.svg?label=Required%20Rust)

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

Under the hood `exonum-api` uses [`actix`].

Consult [the crate docs](https://docs.rs/exonum-api) for more details.

## Examples

Providing HTTP API for a plugin:

```rust
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`:

```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](LICENSE) for details.

[`actix`]: https://crates.io/crates/actix
[rust-runtime]: ../../runtimes/rust