44 releases
0.7.0-alpha.1 | Dec 13, 2019 |
---|---|
0.6.6 | Jul 17, 2019 |
0.6.4 | Feb 27, 2019 |
0.5.9 | Mar 12, 2018 |
0.3.2 | Jul 31, 2017 |
#636 in HTTP server
37 downloads per month
93KB
2K
SLoC
Sincere
Sincere is a micro web framework for Rust(stable) based on hyper and multithreadind. Style like koa. The same, which aims to be a smaller, more expressive, and more robust foundation for web applications and APIs. Sincere does not bundle any middleware within core, and provides an elegant suite of methods that make writing servers fast and enjoyable. Here is an example of a simple application:
extern crate sincere;
use sincere::App;
fn main() {
let mut app = App::new();
app.get("/", |context| {
context.response.from_text("Hello world!").unwrap();
});
app.run("127.0.0.1:8000").unwrap();
}
Don't forget add this to your Cargo.toml
:
[dependencies]
sincere = "0.7.0-alpha.1"
Build and run, then, visiting http://127.0.0.1:8000/
, you will see Hello world
on the screen.
API documentation:
Guide
Routing
app.add("GET", "/user", ...);
app.get("/user", ...);
app.get("/user/{id:[0-9]+}", ...);
app.post("/user", ...);
app.put("/user/{id:[0-9]+}", ...);
app.delete("/user/{id:[0-9]+}", ...);
app.options("/", ...);
app.connect("/", ...);
app.head("/", ...);
Route Group
use sincere::App;
use sincere::Group;
fn main() {
let mut app = App::new();
app.get("/", |context| {
context.response.from_text("Hello world!").unwrap();
});
let mut user_group = Group::new("/user");
// /user
user_group.get("/", ...);
// /user/123
app.get("/{id:[0-9]+}", ...);
app.mount_group(user_group::handle);
app.run("127.0.0.1:8000");
}
use sincere::App;
use sincere::Group;
use sincere::Context;
pub struct User;
impl User {
pub fn list(mut context: &mut Context) {
...
}
pub fn detail(mut context: &mut Context) {
...
}
pub fn handle() -> Group {
let mut group = Group::new("/user");
group.get("/", Self::list);
group.get("/{id:[0-9]+}", Self::detail);
group
}
}
fn main() {
let mut app = App::new();
app.get("/", |context| {
context.response.from_text("Hello world!").unwrap();
});
app.mount(User::handle());
app.run("127.0.0.1:8000");
}
Middleware
use sincere::App;
fn main() {
let mut app = App::new();
app.begin(|context| {
...
});
app.before(|context| {
...
});
app.after(|context| {
...
});
app.finish(|context| {
...
});
app.get("/", |context| {
context.response.from_text("Hello world!").unwrap();
});
app.run("127.0.0.1:8000");
}
...
app.begin(...).begin(...);
app.begin(...).finish(...);
app.begin(...).before(...).after(...).finish(...);
...
app.get("/", |context| {
context.response.from_text("Hello world!").unwrap();
}).before(...).after(...);
let mut group = Group::new("/user");
group.before(...).after(...);
group.get("/", |context| {
context.response.from_text("Hello world!").unwrap();
}).before(...).after(...);
pub fn auth(context: &mut Context) {
if let Some(token) = context.request.get_header("Token") {
match token::verify_token(token) {
Ok(id) => {
context.contexts.insert("id".to_owned(), Value::String(id));
},
Err(err) => {
context.response.from_text("").unwrap();
context.stop();
}
}
} else {
context.response.status_code(401);
context.stop();
}
}
app.post("/article", ...).before(auth);
group.post("/", ...).before(auth);
pub fn cors(app: &mut App) {
app.begin(move |context| {
if context.request.method() == &Method::Options {
context.response
.status_code(204)
.header(("Access-Control-Allow-Methods", "GET,HEAD,PUT,PATCH,POST,DELETE,OPTIONS"));
context.stop();
}
});
app.finish(move |context| {
context.response
.header(("Access-Control-Allow-Origin", "*"))
.header(("Access-Control-Allow-Headers", "content-type, token"));
});
}
app.use_middleware(cors);
Path Parameters
app.get("/user/{id}", |context| {
let id = context.request.param("id").unwrap();
});
app.get("/user/{id:[0-9]+}", |context| {
let id = context.request.param("id").unwrap();
});
app.get("/user/{id:[a-z0-9]{24}}", |context| {
let id = context.request.param("id").unwrap();
});
Query Parameters
/article?per_page=10&page=1
app.get("/article", |content| {
let page = context.request.query("page").unwrap_or("1");
let per_page = context.request.query("per_page").unwrap_or("10");
});
Bind Json
serde_derive = "1.0"
[dependencies.serde_json]
version = "1.0"
features = ["preserve_order"]
#[macro_use]
extern crate serde_derive;
extern crate serde_json;
app.post("/article", |content| {
#[derive(Deserialize, Debug)]
struct New {
title: String,
image: Vec<String>,
content: String
}
let new_json = context.request.bind_json::<New>().unwrap();
// some code
let return_json = json!({
"article_id": 123
});
context.response.from_json(return_json).unwrap();
});
Get and set headers, http status code
app.get("/", |context| {
let token = context.request.header("Token").unwrap_or("none".to_owned());
context.response.from_text("Hello world!").status_code(200).header(("Hello", "World")).unwrap();
});
Dependencies
~19MB
~314K SLoC