Struct seamless::api::RouteBuilder

pub struct RouteBuilder<'a> { /* fields omitted */ }

Add a new API route by providing a description (optional but encouraged) and then a handler function.

Examples

// This route expects a JSON formatted string to be provided, and echoes it straight back.
api.add("some/route/name")
   .description("This route takes some Foo's in and returns some Bar's")
   .handler(|body: Json<String>| async move { Ok::<_,std::convert::Infallible>(body.json) });

// This route delegates to an async fn to sum some values, so we can infer more types in the handler.
api.add("another.route")
   .description("This route takes an array of values and sums them")
   .handler(|body: Json<_>| sum(body.json));

async fn sum(ns: Vec<u64>) -> Result<u64, Infallible> {
    Ok(ns.into_iter().sum())
}

Implementations

impl<'a> RouteBuilder<'a>

pub fn description<S: Into<String>>(self, desc: S) -> Self

Add a description to the API route.

pub fn handler<A, HandlerFn: IntoHandler<ApiError, A>>(self, handler: HandlerFn)

Add a handler to the API route. Until this has been added, the route doesn't "exist".