Rocket

A web framework for Rust.

Github星跟踪图

Rocket

Build Status
Rocket Homepage
Current Crates.io Version
Chat on Matrix
IRC: #rocket on irc.mozilla.org

Rocket is a web framework for Rust (nightly) with a focus on ease-of-use,
expressibility, and speed. Here's an example of a complete Rocket application:

#![feature(proc_macro_hygiene)]

#[macro_use] extern crate rocket;

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

fn main() {
    rocket::ignite().mount("/hello", routes![hello]).launch();
}

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:

The official community support channels are the #rocket IRC channel on the
Mozilla IRC Server at irc.mozilla.org and the bridged Rocket room on
Matrix
. If you're not familiar with IRC, we recommend chatting through Matrix
via Riot
or via the Kiwi web IRC client. You can learn more about IRC via
Mozilla's Getting Started with IRC guide.

Building

Nightly

Rocket requires a nightly version of Rust as it makes heavy use of syntax
extensions. This means that the first two unwieldly lines in the introductory
example above are required.

Core, Codegen, and Contrib

All of the Rocket libraries are managed by Cargo. As a result, compiling them is
simple.

  • Core: cd lib && cargo build
  • Codegen: cd codegen && cargo build
  • Contrib: cd contrib && cargo build --all-features

Examples

Rocket ships with an extensive number of examples in the examples/ directory
which can be compiled and run with Cargo. For instance, the following sequence
of commands builds and runs the Hello, world! example:

cd examples/hello_world
cargo run

You should see Hello, world! by visiting http://localhost:8000.

Testing

To test Rocket, simply run ./scripts/test.sh from the root of the source tree.
This will build and test the core, codegen, and contrib libraries as well
as all of the examples. The test.sh script accepts no flags or either the
--release flag to test in release mode or the --contrib flag to test all
contrib modules individually. This script gets run by CI.

To test a crate individually, run cargo test --all-features in the
corresponding crate directory.

Core

Testing for the core library is done inline in the corresponding module. For
example, the tests for routing can be found at the bottom of the
lib/src/router/mod.rs file.

Codegen

Code generation tests can be found in codegen/tests. We use the compiletest
library, which was extracted from rustc, for testing. See the compiler test
documentation
for information on how to write compiler tests.

Documentation

You can build the Rocket API documentation locally by running
./scripts/mk-docs.sh. The resulting documentation is what gets uploaded to
api.rocket.rs.

Contributing

Contributions are absolutely, positively welcome and encouraged! Contributions
come in many forms. 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. Contribute code via pull requests.

We aim to keep Rocket's code quality at the highest level. This means that any
code you contribute must be:

  • Commented: Public items must be commented.
  • Documented: Exposed items must have rustdoc comments with
    examples, if applicable.
  • Styled: Your code should be rustfmt'd when possible.
  • Simple: Your code should accomplish its task as simply and
    idiomatically as possible.
  • Tested: You must add (and pass) convincing tests for any functionality you add.
  • Focused: Your code should do what it's supposed to do and nothing more.

All pull requests are code reviewed and tested by the CI. Note that 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.

License

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

The Rocket website source is licensed under separate terms.

主要指标

概览
名称与所有者rwf2/Rocket
主编程语言Rust
编程语言Rust (语言数: 5)
平台
许可证Other
所有者活动
创建于2016-03-18 02:50:18
推送于2025-05-04 10:05:41
最后一次提交2025-05-04 05:05:08
发布数63
最新版本名称v0.5.1 (发布于 )
第一版名称v0.0.5 (发布于 )
用户参与
星数25.3k
关注者数271
派生数1.6k
提交数2.4k
已启用问题?
问题数1571
打开的问题数53
拉请求数35
打开的拉请求数25
关闭的拉请求数748
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?