Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chopinsky/rusty_express
A simple http-server library in Rust, which provides Express-alike APIs and emphasizes performance.
https://github.com/chopinsky/rusty_express
backend http-server rust simple
Last synced: 25 days ago
JSON representation
A simple http-server library in Rust, which provides Express-alike APIs and emphasizes performance.
- Host: GitHub
- URL: https://github.com/chopinsky/rusty_express
- Owner: Chopinsky
- License: mit
- Created: 2018-01-14T23:47:37.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-01-05T05:22:55.000Z (about 5 years ago)
- Last Synced: 2024-12-15T09:40:45.336Z (27 days ago)
- Topics: backend, http-server, rust, simple
- Language: Rust
- Homepage: https://crates.io/crates/rusty_express
- Size: 931 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[Rusty_Express][docsrs]
======================
[![Rusty_Express on crates.io][cratesio-image]][cratesio]
[![Rusty_Express on docs.rs][docsrs-image]][docsrs]
[cratesio]: https://crates.io/crates/rusty_express
[cratesio-image]: https://img.shields.io/crates/v/rusty_express.svg
[docsrs-image]: https://docs.rs/rusty_express/badge.svg
[docsrs]: https://docs.rs/rusty_express
## What is this
This is a simple http-server library written in Rust and provide Express-alike APIs. We know Rust
is hard and daunting to use, so the goal of this project is to make sure your server can be easy
to construct without fears such that you can focus on the business logic.
Many of today's popular Rust-based web framework are verbose and would take efforts to learn, one will
usually have to be familiar with advanced Rust features or API libraries in order to finish a seemingly
easy job in other language's framework. That's why we started this project -- we want it to be easy to
use as a back-end technology, and provide native experience similar to Node's Express framework. That's
where this project got its name -- "Rusty Express": a Rust based, Express-alike web framework.
Version 0.3.0+ is a major milestone, from this point on the APIs shall be mostly stable, and we
expect to make less, if none, break changes, but please do let us know if you've come across bugs
that we should fix, or have met performance bottle necks that we shall try to improve.
## What's new in 0.4.2
- Small fixes
## Migrating from 0.2.x to 0.3.0 and beyond
0.2.x versions are good experiments with this project. But we're growing fast with better
features and more performance enhancement! That's why we need to start the 0.3.x versions
with slight changes to the interface APIs.
Here're what to expect when updating from 0.2.x to 0.3.0:
- The route handler function's signature has changed, now the request and response objects
are boxed! So now your route handler should have something similar to this:
```rust
pub fn handler(req: &Box, resp: &mut Box) {
/// work hard to generate the response here...
}
```
- The `StateProvider` trait is deprecated (and de-factor no-op in 0.3.0), and it will be removed in
the 0.3.3 release. Please switch to use the `ServerContext` features instead. You can find how to
use the `ServerContext` in this example: [Server with defined router](https://github.com/Chopinsky/Rusty_Express/blob/master/examples/use_router.rs)
## How to use
In your project's `Cargo.toml`, add dependency:
```cargo
[dependencies]
rusty_express = "^0.3.0"
...
```
In `src\main.rs`:
```rust
extern crate rusty_express;
use rusty_express::prelude::*;
fn main() {
//A http server with default thread pool size of 4
let mut server = HttpServer::new();
//Change thread pool size from 8 (default) to 10.
server.set_pool_size(10);
//Route definition
server.get(RequestPath::Exact("/"), handler);
//Listen to port 8080, server has started.
server.listen(8080);
}
pub fn handler(req: &Box, resp: &mut Box) {
resp.send("Hello world from the rusty-express server!\n");
resp.status(200);
}
```
## Examples
- [Simple server](https://github.com/Chopinsky/Rusty_Express/blob/master/examples/simple.rs)
- [Server with defined router](https://github.com/Chopinsky/Rusty_Express/blob/master/examples/use_router.rs)
- [Use redirect in the router](https://github.com/Chopinsky/Rusty_Express/blob/master/examples/simple_redirect.rs)