exonum-system-api 1.0.0

System API plugin for 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

# System API for Exonum node

[![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)

Plugin extending HTTP API of the node to return information about node state.

## Description

The system API plugin provides information about the node state using REST interface.
The following info can be retrieved:

- Information about the current set of artifacts and services
- Network connectivity stats
- Version of Exonum / Rust that the node was compiled with

## HTTP API

REST API of the service is documented in the crate docs.

## Usage

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

```toml
[dependencies]
exonum-system-api = "1.0.0"
```

`SystemApiPlugin` type, located at the root of the crate, should be used
as a node plugin during node creation.
Consult [the crate docs](https://docs.rs/exonum-system-api) for more details.

## License

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