Documentation

Guides, recipes, and API reference for building async web apps with Suave.

Getting started

Getting started

Install Suave and run Hello World.

Routing & handlers

URL patterns, methods, and typed routes.

Requests & responses

Query strings, forms, headers, and JSON.

Core

Router

Path parameters, scopes, and wildcards.

Bindings & config

Ports, TLS, and SuaveConfig.

Files

Static files, uploads, and streaming.

Composition

Middleware and pipelines.

Async & >=>

WebParts, Kleisli composition, short-circuiting.

Operators

Reference for >=>, <|>, and helpers.

Sessions

Cookie state and server keys.

Validation & security

CORS, headers, auth.

Rate limiting

Fixed window, sliding window, token bucket.

Logging

Built-in Logger and redirection tips.

WebSockets

Realtime bidirectional messaging.

HTTP/2

Automatic multiplexed HTTP/2.

DotLiquid

HTML templating package.

Deployment

Docker, nginx, systemd.

Performance

Tuning and benchmarks.

Recipes, FAQ & API

Recipes

Copy-paste how-tos for common tasks.

FAQ

Answers to common pitfalls.

Module map

Overview of public modules.

API reference

Generated docs for every type and member.