The Rocket Programming Guide
Welcome to Rocket!
This is the official guide for Rocket v0.5. It is designed to serve as a starting point to writing web applications with Rocket and Rust. The guide is also designed to be a reference for experienced Rocket developers. This guide is conversational in tone. For purely technical documentation with examples, see the API documentation.
The guide is split into several sections, each with a focus on a different aspect of Rocket. The sections are:
- Introduction - introduces Rocket and its philosophy
- Upgrading - a migration guide from Rocket v0.4 to v0.5
- Quickstart - the minimal steps to running your first Rocket application
- Getting Started - a gentle introduction to running your first Rocket application
- Overview - an overview of Rocket's core concepts
- Requests - handling request and body data: control-flow, parsing, validation
- Responses - generating responses and using typed URIs
- State - managing application state and connecting to databases
- Fairings - Rocket's structured middleware
- Testing - unit and integration testing with the built-in testing library
- Configuration - overview and customization of Rocket application configuration
- Pastebin Tutorial - step-by-step guide to creating a pastebin with Rocket
- Conclusion - next steps, and learning more about Rocket
- FAQ - answers to frequently asked questions about Rocket and its usage
Getting Help
The official community support channels are via Matrix chat on #rocket:mozilla.org and via GitHub Discussions. To join us on Matrix, we recommend the browser-based Element client. The FAQ also provides answers to commonly asked questions.
