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)

Searching Database…

25.8K ·GitHub
Rocket
Что это такое?Rocket — это асинхронный веб-фреймворк для Rust, ориентированный на удобство, безопасность, расширяемость и скорость: вы пишете на Rust, а Rocket берёт на себя маршрутизацию и обработку веб-запросов.
Так это фреймворк, на котором я строю своё приложение, или библиотека, которую я подключаю к готовому коду?Фреймворк: вы описываете маршруты на Rust, а Rocket передаёт входящие запросы им — как маршрут hello из README, который приветствует посетителя по адресу /hello/John/58.
Как запустить своё первое приложение на Rocket?Возьмите готовый crate из каталога examples в репозитории и запустите его с помощью Cargo, например пример hello — каждый пример является самостоятельным приложением.
Что нужно установить заранее?Только инструментарий Rust: примеры компилируются и запускаются с помощью Cargo, а в README не требуется никаких других рантаймов, баз данных или сервисов.
Что будет, если посетитель зайдёт по маршруту и передаст текст там, где ожидается число?Ваш обработчик вообще не будет вызван: Rocket разбирает сегменты пути в типы параметров обработчика, и значение, которое не удаётся распарсить (текст вместо числа u8 для возраста), даёт ошибку 404.
Rocket — это молодой эксперимент или проверенное временем решение?Он разрабатывается с марта 2016 года и собрал около 25.8k звёзд на GitHub; документация для веток собирается и выкладывается при каждом коммите, так что разработка идёт активно.
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