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 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
use std::collections::HashMap; use http::{ Request, Response, method::Method }; use serde::{ Serialize }; use super::info::{ ApiBodyInfo }; use super::error::ApiError; use crate::handler::{ Handler, IntoHandler }; /// The entry point; you can create an instance of this and then add API routes to it /// using [`Self::add()`]. You can then get information about the routes that have been added /// using [`Self::info()`], or handle an [`http::Request`] using [`Self::handle()`]. pub struct Api { base_path: String, routes: HashMap<(Method,String),ResolvedApiRoute<ApiError>> } // An API route has the contents of `ResolvedHandler` but also a description. struct ResolvedApiRoute<E> { description: String, resolved_handler: Handler<E> } impl Api { /// Instantiate a new API. pub fn new() -> Api { Api::new_with_base_path("") } /// Instantiate a new API that will handle requests that begin with the /// provided base path. /// /// For example, if the provided `base_path` is "/foo/bar", and a route with /// the path "hi" is added, then an incoming [`http::Request`] with the path /// `"/foo/bar/hi"` will match it. pub fn new_with_base_path<S: Into<String>>(base_path: S) -> Api { Api { base_path: base_path.into(), routes: HashMap::new() } } /// Add a new route to the API. You must provide a path to make this route available at, /// and are given back a [`RouteBuilder`] which can be used to give the route a handler /// and a description. /// /// # Examples /// /// ``` /// # use seamless::{ Api, handler::body::Json }; /// # use std::convert::Infallible; /// # let mut api = Api::new(); /// // 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()) /// } /// ``` pub fn add<P: Into<String>>(&mut self, path: P) -> RouteBuilder { RouteBuilder::new(self, path.into()) } // Add a route given the individual parts (for internal use) fn add_parts<A, P: Into<String>, HandlerFn: IntoHandler<ApiError,A>>(&mut self, path: P, description: String, handler_fn: HandlerFn) { let resolved_handler = handler_fn.into_handler(); let mut path: String = path.into(); path = path.trim_matches('/').to_owned(); self.routes.insert((resolved_handler.method.clone(), path.into()), ResolvedApiRoute { description, resolved_handler }); } /// Match an incoming [`http::Request`] against our API routes and run the relevant handler if a /// matching one is found. We'll get back bytes representing a JSON response back if all goes ok, /// else we'll get back a [`RouteError`], which will either be [`RouteError::NotFound`] if no matching /// route was found, or a [`RouteError::Err`] if a matching route was found, but that handler emitted /// an error. pub async fn handle(&self, req: Request<Vec<u8>>) -> Result<Response<Vec<u8>>,RouteError<ApiError>> { let base_path = &self.base_path.trim_start_matches('/'); let req_path = req.uri().path().trim_start_matches('/'); if req_path.starts_with(base_path) { // Ensure that the method and path suffix lines up as expected: let req_method = req.method().into(); let req_path_tail = req_path[base_path.len()..].trim_start_matches('/').to_owned(); if let Some(route) = self.routes.get(&(req_method,req_path_tail)) { (route.resolved_handler.handler)(req).await.map_err(RouteError::Err) } else { Err(RouteError::NotFound(req)) } } else { Err(RouteError::NotFound(req)) } } /// Return information about the API routes that have been defined so far. pub fn info(&self) -> Vec<RouteInfo> { let mut info = vec![]; for ((_method,key), val) in &self.routes { info.push(RouteInfo { name: key.to_owned(), method: format!("{}", &val.resolved_handler.method), description: val.description.clone(), request_type: val.resolved_handler.request_type.clone(), response_type: val.resolved_handler.response_type.clone() }); } info.sort_by(|a,b| a.name.cmp(&b.name)); info } } /// Add a new API route by providing a description (optional but encouraged) /// and then a handler function. /// /// # Examples /// /// ``` /// # use seamless::{ Api, handler::body::Json }; /// # use std::convert::Infallible; /// # let mut api = Api::new(); /// // 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()) /// } /// ``` pub struct RouteBuilder<'a> { api: &'a mut Api, path: String, description: String } impl <'a> RouteBuilder<'a> { fn new(api: &'a mut Api, path: String) -> Self { RouteBuilder { api, path, description: String::new() } } /// Add a description to the API route. pub fn description<S: Into<String>>(mut self, desc: S) -> Self { self.description = desc.into(); self } /// Add a handler to the API route. Until this has been added, the route /// doesn't "exist". pub fn handler<A, HandlerFn: IntoHandler<ApiError,A>>(self, handler: HandlerFn) { self.api.add_parts(self.path, self.description, handler); } } /// A route is either not found, or we attempted to run it and ran into /// an issue. #[derive(Debug)] pub enum RouteError<E> { /// No route matched the provided request, /// so we hand it back. NotFound(Request<Vec<u8>>), /// The matching route failed; this is the error. Err(E) } impl <E> RouteError<E> { /// Assume that the `RouteError` contains an error and attempt to /// unwrap this /// /// # Panics /// /// Panics if the RouteError does not contain an error pub fn unwrap_err(self) -> E { match self { RouteError::Err(e) => e, _ => panic!("Attempt to unwrap_api_err on RouteError that is NotFound") } } } /// Information about a single route. #[derive(Debug,Clone,PartialEq,Serialize)] pub struct RouteInfo { /// The name/path that the [`http::Request`] needs to contain /// in order to match this route. pub name: String, /// The HTTP method expected in order for a [`http::Request`] to /// match this route, as a string. pub method: String, /// The description of the route as set by [`RouteBuilder::description()`] pub description: String, /// The shape of the data expected to be provided as part of the [`http::Request`] /// for this route. This doesn't care about the wire format that the data is provided in, /// though the type information is somewhat related to what the possible types that can /// be sent and received via JSON. /// /// Types can use the [`macro@crate::ApiBody`] macro, or implement [`type@crate::api::ApiBody`] /// manually in order to describe the shape and documentation that they should hand back. pub request_type: ApiBodyInfo, /// The shape of the data that is returned from this API route. pub response_type: ApiBodyInfo }