Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danclive/sincere
Sincere is a micro web framework for Rust(stable) based on hyper and multithreading
https://github.com/danclive/sincere
epoll http hyper rust web-framework
Last synced: 3 months ago
JSON representation
Sincere is a micro web framework for Rust(stable) based on hyper and multithreading
- Host: GitHub
- URL: https://github.com/danclive/sincere
- Owner: danclive
- License: mit
- Created: 2017-01-24T14:53:07.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-10-17T07:29:53.000Z (about 4 years ago)
- Last Synced: 2024-05-18T14:05:06.108Z (8 months ago)
- Topics: epoll, http, hyper, rust, web-framework
- Language: Rust
- Homepage:
- Size: 199 KB
- Stars: 96
- Watchers: 4
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rust-cn - danclive/sincere - ci.org/danclive/sincere.svg?branch=master">](https://travis-ci.org/danclive/sincere) (Libraries / Web programming)
- awesome-rust - danclive/sincere - ci.org/danclive/sincere.svg?branch=master">](https://travis-ci.org/danclive/sincere) (Libraries / Web programming)
- awesome-rust - danclive/sincere
- awesome-rust-cn - danclive/sincere
- awesome-rust-zh - danclive/sincere - 基于 hyper 和多线程的 Rust（稳定）的微型 Web 框架。[<img src="https://api.travis-ci.org/danclive/sincere.svg?branch=master">](https://travis-ci.org/danclive/sincere) (库 / 网页编程)
README
# The project is no longer maintained！
# Sincere
[](https://crates.io/crates/sincere)
[](https://travis-ci.org/danclive/sincere)
[](./LICENSE)
[](https://docs.rs/sincere)
Sincere is a micro web framework for Rust(stable) based on hyper and multithreading. 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:
```rust
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`:
```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:
- [master](https://docs.rs/sincere)
## Guide
### Routing
```rust
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
```rust
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");
}
```
```rust
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
```rust
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");
}
```
```rust
...
app.begin(...).begin(...);
app.begin(...).finish(...);
app.begin(...).before(...).after(...).finish(...);
...
```
```rust
app.get("/", |context| {
context.response.from_text("Hello world!").unwrap();
}).before(...).after(...);
```
```rust
let mut group = Group::new("/user");
group.before(...).after(...);
group.get("/", |context| {
context.response.from_text("Hello world!").unwrap();
}).before(...).after(...);
```
```rust
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);
```
```rust
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
```rust
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`
```rust
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
```toml
serde_derive = "1.0"
[dependencies.serde_json]
version = "1.0"
features = ["preserve_order"]
```
```rust
#[macro_use]
extern crate serde_derive;
extern crate serde_json;
```
```rust
app.post("/article", |content| {
#[derive(Deserialize, Debug)]
struct New {
title: String,
image: Vec,
content: String
}
let new_json = context.request.bind_json::().unwrap();
// some code
let return_json = json!({
"article_id": 123
});
context.response.from_json(return_json).unwrap();
});
```
### Get and set headers, http status code
```rust
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();
});
```