Introduction

This book is a work in progress. If you can't find the information you need here, check the doc.rs documentation or open a GitHub discussion.

This book is intended as a guide for how to use Roadster, a "batteries included" web framework for Rust designed to get you moving fast 🏎️. Compared to low-level web frameworks such as Axum or Actix, which only provide the functionality to create an API, Roadster aims to provide all the other functionality needed to create a fully-featured backend or fullstack web app. Roadster is designed to provide sensible defaults for all features while remaining highly configurable, customizable, and pluggable. This allows you to focus on creating your application instead of wiring up all of your dependencies, while still allowing you the flexibility to customize your dependencies if needed.

If you're unsure if Roadster is the best fit for your project, a collection of comparisons to other Rust web frameworks can be found in Web framework comparisons. The full list of Roadster's features can be found in Roadster features.

Prerequisite reading

This book assumes the reader has some knowledge of how to program in Rust. If you are new to Rust, you may find the following helpful to better understand how to use Roadster:

In addition, as asynchronous programming is essential for writing performant web apps, some knowledge of async programming in Rust is assumed. If you are unfamiliar with async Rust, you may find the following helpful: