Welcome

Hey there!
This is the documentation for Pavex, a framework for building robust APIs in Rust.

Getting Started

If you're new to Pavex, head over to the "Getting started" section.
It'll walk you through the process of setting up a new Pavex project from scratch. You'll learn how to install the required tools, how to create a new project, and how to run it.

If you're not sure whether Pavex is the right choice for your project, check out the "Why Pavex?" section for a high-level overview of the framework's design goals and features.

Going Deeper

Are you already hacking on a Pavex project?
Get familiar with the "Guide" and the "API Reference" sections!

The "Guide" is organised by topic. Each section focuses on one aspect of the framework (e.g. routing, middlewares, etc.), with examples and code snippets. It's the best place to build a mental model of the framework and learn how to wield it effectively.

The "API Reference", instead, contains the auto-generated documentation for all the first-party crates in the Pavex ecosystem.
It's your go-to place for the nitty-gritty details of all the types and functions exposed by the framework. It's the same documentation shown in your IDE when you hover over a type or function.