Module splinter::rest_api[−][src]

Expand description

Rest API Module.

Module for creating REST APIs for services.

Below is an example of a struct that implements ResouceProvider and then passes its resources to a running instance of RestApi.

use actix_web::HttpResponse;
use cylinder::{VerifierFactory, secp256k1::Secp256k1Context};
use futures::IntoFuture;
use splinter::rest_api::{
    AuthConfig, Resource, Method, RestApiBuilder, RestResourceProvider,
    auth::authorization::Permission,
};

struct IndexResource {
    pub name: String
}

impl RestResourceProvider for IndexResource {
    fn resources(&self) -> Vec<Resource> {
        let name = self.name.clone();

        vec![Resource::build("/index").add_method(
            Method::Get,
            Permission::AllowUnauthenticated,
            move |r, p| {
                Box::new(
                    HttpResponse::Ok()
                    .body(format!("Hello, I am {}", name))
                    .into_future())
            },
        )]
    }
}

let index_resource = IndexResource { name: "Taco".to_string() };

#[cfg(not(feature = "https-bind"))]
let bind = "localhost:8080";
#[cfg(feature = "https-bind")]
let bind = splinter::rest_api::BindConfig::Http("localhost:8080".into());

RestApiBuilder::new()
    .add_resources(index_resource.resources())
    .with_bind(bind)
    .with_auth_configs(vec![AuthConfig::Cylinder{
        verifier: Secp256k1Context::new().new_verifier(),
    }])
    .build()
    .unwrap()
    .run();