├── .gitignore ├── Cargo.toml ├── LICENSE ├── Makefile ├── README.md ├── rustfmt.toml └── src ├── handler.rs ├── main.rs └── router.rs /.gitignore: -------------------------------------------------------------------------------- 1 | # Generated by Cargo 2 | # will have compiled files and executables 3 | /target/ 4 | 5 | # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries 6 | # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html 7 | Cargo.lock 8 | 9 | # These are backup files generated by rustfmt 10 | **/*.rs.bk 11 | 12 | 13 | # Added by cargo 14 | 15 | /target 16 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "rust-minimal-web-service-hyper" 3 | version = "0.1.0" 4 | authors = ["Mario Zupan "] 5 | edition = "2018" 6 | 7 | [dependencies] 8 | futures = { version = "0.3.6", default-features = false, features = ["async-await"] } 9 | hyper = "0.13" 10 | tokio = { version = "0.2", features = ["macros", "rt-threaded"] } 11 | serde = {version = "1.0", features = ["derive"] } 12 | serde_json = "1.0" 13 | route-recognizer = "0.2" 14 | bytes = "0.5" 15 | async-trait = "0.1" 16 | 17 | [profile.dev] 18 | debug = 0 19 | 20 | [profile.test] 21 | debug = 0 22 | 23 | [profile.release] 24 | panic = 'abort' 25 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | build: 2 | @cargo build 3 | 4 | clean: 5 | @cargo clean 6 | 7 | TESTS = "" 8 | test: 9 | @cargo test $(TESTS) --offline --lib -- --color=always --nocapture 10 | 11 | docs: build 12 | @cargo doc --no-deps 13 | 14 | style-check: 15 | @rustup component add rustfmt 2> /dev/null 16 | cargo fmt --all -- --check 17 | 18 | lint: 19 | @rustup component add clippy 2> /dev/null 20 | cargo clippy --all-targets --all-features -- -D warnings 21 | 22 | dev: 23 | cargo run 24 | 25 | .PHONY: build test docs style-check lint 26 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # rust-minimal-web-service-hyper 2 | 3 | An example of a minimal web service in Rust using hyper 4 | 5 | Run with `make dev` 6 | 7 | URLs to call: 8 | 9 | ```bash 10 | curl http://localhost:8080/test 11 | 12 | curl http://localhost:8080/params/1234 13 | 14 | curl -X POST http://localhost:8080/send -d '{"name": "chip", "active": true }' 15 | ``` 16 | -------------------------------------------------------------------------------- /rustfmt.toml: -------------------------------------------------------------------------------- 1 | edition = "2018" 2 | -------------------------------------------------------------------------------- /src/handler.rs: -------------------------------------------------------------------------------- 1 | use crate::{Context, Response}; 2 | use hyper::StatusCode; 3 | use serde::Deserialize; 4 | 5 | pub async fn test_handler(ctx: Context) -> String { 6 | format!("test called, state_thing was: {}", ctx.state.state_thing) 7 | } 8 | 9 | #[derive(Deserialize)] 10 | struct SendRequest { 11 | name: String, 12 | active: bool, 13 | } 14 | 15 | pub async fn send_handler(mut ctx: Context) -> Response { 16 | let body: SendRequest = match ctx.body_json().await { 17 | Ok(v) => v, 18 | Err(e) => { 19 | return hyper::Response::builder() 20 | .status(StatusCode::BAD_REQUEST) 21 | .body(format!("could not parse JSON: {}", e).into()) 22 | .unwrap() 23 | } 24 | }; 25 | 26 | Response::new( 27 | format!( 28 | "send called with name: {} and active: {}", 29 | body.name, body.active 30 | ) 31 | .into(), 32 | ) 33 | } 34 | 35 | pub async fn param_handler(ctx: Context) -> String { 36 | let param = match ctx.params.find("some_param") { 37 | Some(v) => v, 38 | None => "empty", 39 | }; 40 | format!("param called, param was: {}", param) 41 | } 42 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | use bytes::Bytes; 2 | use hyper::{ 3 | body::to_bytes, 4 | service::{make_service_fn, service_fn}, 5 | Body, Request, Server, 6 | }; 7 | use route_recognizer::Params; 8 | use router::Router; 9 | use std::sync::Arc; 10 | 11 | mod handler; 12 | mod router; 13 | 14 | type Response = hyper::Response; 15 | type Error = Box; 16 | 17 | #[derive(Clone, Debug)] 18 | pub struct AppState { 19 | pub state_thing: String, 20 | } 21 | 22 | #[tokio::main] 23 | async fn main() { 24 | let some_state = "state".to_string(); 25 | 26 | let mut router: Router = Router::new(); 27 | router.get("/test", Box::new(handler::test_handler)); 28 | router.post("/send", Box::new(handler::send_handler)); 29 | router.get("/params/:some_param", Box::new(handler::param_handler)); 30 | 31 | let shared_router = Arc::new(router); 32 | let new_service = make_service_fn(move |_| { 33 | let app_state = AppState { 34 | state_thing: some_state.clone(), 35 | }; 36 | 37 | let router_capture = shared_router.clone(); 38 | async { 39 | Ok::<_, Error>(service_fn(move |req| { 40 | route(router_capture.clone(), req, app_state.clone()) 41 | })) 42 | } 43 | }); 44 | 45 | let addr = "0.0.0.0:8080".parse().expect("address creation works"); 46 | let server = Server::bind(&addr).serve(new_service); 47 | println!("Listening on http://{}", addr); 48 | let _ = server.await; 49 | } 50 | 51 | async fn route( 52 | router: Arc, 53 | req: Request, 54 | app_state: AppState, 55 | ) -> Result { 56 | let found_handler = router.route(req.uri().path(), req.method()); 57 | let resp = found_handler 58 | .handler 59 | .invoke(Context::new(app_state, req, found_handler.params)) 60 | .await; 61 | Ok(resp) 62 | } 63 | 64 | #[derive(Debug)] 65 | pub struct Context { 66 | pub state: AppState, 67 | pub req: Request, 68 | pub params: Params, 69 | body_bytes: Option, 70 | } 71 | 72 | impl Context { 73 | pub fn new(state: AppState, req: Request, params: Params) -> Context { 74 | Context { 75 | state, 76 | req, 77 | params, 78 | body_bytes: None, 79 | } 80 | } 81 | 82 | pub async fn body_json(&mut self) -> Result { 83 | let body_bytes = match self.body_bytes { 84 | Some(ref v) => v, 85 | _ => { 86 | let body = to_bytes(self.req.body_mut()).await?; 87 | self.body_bytes = Some(body); 88 | self.body_bytes.as_ref().expect("body_bytes was set above") 89 | } 90 | }; 91 | Ok(serde_json::from_slice(&body_bytes)?) 92 | } 93 | } 94 | -------------------------------------------------------------------------------- /src/router.rs: -------------------------------------------------------------------------------- 1 | use crate::{Context, Response}; 2 | use async_trait::async_trait; 3 | use futures::future::Future; 4 | use hyper::{Method, StatusCode}; 5 | use route_recognizer::{Match, Params, Router as InternalRouter}; 6 | use std::collections::HashMap; 7 | 8 | #[async_trait] 9 | pub trait Handler: Send + Sync + 'static { 10 | async fn invoke(&self, context: Context) -> Response; 11 | } 12 | 13 | #[async_trait] 14 | impl Handler for F 15 | where 16 | F: Fn(Context) -> Fut, 17 | Fut: Future + Send + 'static, 18 | Fut::Output: IntoResponse, 19 | { 20 | async fn invoke(&self, context: Context) -> Response { 21 | (self)(context).await.into_response() 22 | } 23 | } 24 | 25 | pub struct RouterMatch<'a> { 26 | pub handler: &'a dyn Handler, 27 | pub params: Params, 28 | } 29 | 30 | pub struct Router { 31 | method_map: HashMap>>, 32 | } 33 | 34 | impl Router { 35 | pub fn new() -> Router { 36 | Router { 37 | method_map: HashMap::default(), 38 | } 39 | } 40 | 41 | pub fn get(&mut self, path: &str, handler: Box) { 42 | self.method_map 43 | .entry(Method::GET) 44 | .or_insert_with(InternalRouter::new) 45 | .add(path, handler) 46 | } 47 | 48 | pub fn post(&mut self, path: &str, handler: Box) { 49 | self.method_map 50 | .entry(Method::POST) 51 | .or_insert_with(InternalRouter::new) 52 | .add(path, handler) 53 | } 54 | 55 | pub fn route(&self, path: &str, method: &Method) -> RouterMatch<'_> { 56 | if let Some(Match { handler, params }) = self 57 | .method_map 58 | .get(method) 59 | .and_then(|r| r.recognize(path).ok()) 60 | { 61 | RouterMatch { 62 | handler: &**handler, 63 | params, 64 | } 65 | } else { 66 | RouterMatch { 67 | handler: ¬_found_handler, 68 | params: Params::new(), 69 | } 70 | } 71 | } 72 | } 73 | 74 | async fn not_found_handler(_cx: Context) -> Response { 75 | hyper::Response::builder() 76 | .status(StatusCode::NOT_FOUND) 77 | .body("NOT FOUND".into()) 78 | .unwrap() 79 | } 80 | 81 | pub trait IntoResponse: Send + Sized { 82 | fn into_response(self) -> Response; 83 | } 84 | 85 | impl IntoResponse for Response { 86 | fn into_response(self) -> Response { 87 | self 88 | } 89 | } 90 | 91 | impl IntoResponse for &'static str { 92 | fn into_response(self) -> Response { 93 | Response::new(self.into()) 94 | } 95 | } 96 | 97 | impl IntoResponse for String { 98 | fn into_response(self) -> Response { 99 | Response::new(self.into()) 100 | } 101 | } 102 | --------------------------------------------------------------------------------