exonum-system-api 1.0.0-rc.1

System API plugin for the Exonum framework
Documentation

System API for Exonum node

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

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:

[dependencies]
exonum-system-api = "1.0.0-rc.1"

SystemApiPlugin type, located at the root of the crate, should be used as a node plugin during node creation. Consult the crate docs for more details.

License

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