Rocket README

The project's README from github.com/rwf2/Rocket. As one markdown file: README.md.

Rocket

Build Status Rocket Homepage Current Crates.io Version Matrix: #rocket:mozilla.org

Rocket is an async web framework for Rust with a focus on usability, security, extensibility, and speed.

#[macro_use] extern crate rocket;

#[get("/<name>/<age>")]
fn hello(name: &str, age: u8) -> String {
    format!("Hello, {} year old named {}!", age, name)
}

#[launch]
fn rocket() -> _ {
    rocket::build().mount("/hello", routes![hello])
}

Visiting localhost:8000/hello/John/58, for example, will trigger the hello route resulting in the string Hello, 58 year old named John! being sent to the browser. If an <age> string was passed in that can't be parsed as a u8, the route won't get called, resulting in a 404 error.

Documentation

Rocket is extensively documented:

Documentation for the master branch is available at https://rocket.rs/master and https://api.rocket.rs/master.

Documentation for major release version ${x} is available at https://[api.]rocket.rs/v${x}. For example, the v0.4 docs are available at https://rocket.rs/v0.4 and https://api.rocket.rs/v0.4.

Finally, API docs for active git branches are available at https://api.rocket.rs/${branch}. For example, API docs for the master branch are available at https://api.rocket.rs/master. Branch rustdocs are built and deployed on every commit.

Examples

The examples directory contains complete crates that showcase Rocket's features and usage. Each example can be compiled and run with Cargo. For instance, the following sequence of commands builds and runs the hello example:

cd examples/hello
cargo run

Getting Help

If you find yourself needing help outside of the documentation, you may:

Contributing

Contributions are absolutely, positively welcomed and encouraged! If you're interested in contributing code, please first read CONTRIBUTING for complete guidelines. Additionally, you could:

  1. Submit a feature request or bug report as an issue.
  2. Ask for improved documentation as an issue.
  3. Comment on issues that require feedback.
  4. Answers questions in GitHub discussions questions.
  5. Share a project in GitHub discussions show & tell.

License

Rocket is licensed under either of the following, at your option:

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Rocket by you shall be dual licensed under the MIT License and Apache License, Version 2.0, without any additional terms or conditions.

The Rocket website docs are licensed under separate terms. Any contribution intentionally submitted for inclusion in the Rocket website docs by you shall be licensed under those terms.

Rocket (rwf2/Rocket)

web-server
Searching Database…

25.8K ·GitHub
Rocket
What is this?Rocket is an async web framework for Rust focused on usability, security, extensibility, and speed — you write Rust, and Rocket handles routing and dispatching web requests.
So is it a framework I build my app on, or a library I plug into existing code?A framework: you define routes in Rust and Rocket dispatches incoming requests to them — like the README's hello route that greets visitors at /hello/John/58.
How do I get a first Rocket app running?Take a complete crate from the repo's examples directory and run it with Cargo, for instance the hello example — every example is a self-contained app.
What do I need to have installed before starting?Just the Rust toolchain: the examples compile and run with Cargo, and the README requires no other runtime, database, or service.
What happens if a visitor hits a route with text where a number is expected?Your handler is never called: Rocket parses path segments into the handler's parameter types, and a value that can't be parsed (text for a u8 age) results in a 404.
Is Rocket a young experiment or a battle-tested choice?It has been developed since March 2016 and has about 25.8k GitHub stars; branch rustdocs are built and deployed on every commit, so development is active.
What are similar projects?hapi, axum, express, ktor, beego, actix-web, Slim, martini
Which topics is it in?routing, web-server, async, web-framework, http, rest-api, backend, web-development, performance, rust, framework, security
Creator
rwf2
Size
8.3 MB
Stars
25.8K
Updated
CommitDec 28Releasev0.5.1May 23
Age
10y
Commits · 90 Days