Documentation

Learn how to build fast, type-safe web applications with Suave. Everything you need from basic routing to advanced patterns.

Getting Started

📦 Getting Started

Installation, your first project, and building a "Hello World" web server with Suave.

🛣️ Routing & Handlers

Define URL patterns, path matching, HTTP methods, and build REST APIs with typed routes.

⚙️ Requests & Responses

Handle query strings, form data, headers, JSON bodies, and build type-safe responses.

Core Features

🧭 Router Module

Advanced routing with path parameters, scopes, wildcards, and efficient pattern matching.

🔗 Bindings & Configuration

Configure ports, HTTPS/TLS, server settings, and deployment options.

📁 File Handling & Static Files

Serve static files, handle file uploads, stream large files, and manage static content.

🔄 Composition & Middleware

Combine handlers, build middleware pipelines, and compose complex applications.

Validation & Security

Input validation, CORS, security headers, authentication, and rate limiting.

🔌 WebSockets

Real-time bidirectional communication with full WebSocket support.

Performance

Optimization techniques and performance benchmarks.

Community & Resources

Troubleshooting

  • Port already in use? Change the port in defaultConfig or use a different binding.
  • HTTPS not working? See the Bindings & Configuration guide.
  • Looking for more examples? Check the examples folder on GitHub.