Toggle navigation
plumber
Docs
Examples
GitHub Webhook
Receive Emails (mailgun)
See code on GitHub
1
Introduction
1.1
Web APIs
1.2
Installation
2
Quickstart
2.1
Specifying the Inputs
2.2
Customizing The Output
3
Routing & Input
3.1
Endpoints
3.2
Filters
3.2.1
Forward to Another Handler
3.2.2
Return a Response
3.2.3
Throw an Error
3.3
Dynamic Routes
3.4
Typed Dynamic Routes
3.5
Static File Handler
3.6
Input Handling
3.6.1
The Request Object
3.6.2
Query Strings
3.6.3
Request Body
3.6.4
Cookies
3.6.5
Headers
4
Rendering Output
4.1
The Response Object
4.2
Serializers
4.2.1
Bypassing Serialization
4.2.2
Boxed vs Unboxed JSON
4.2.3
Customizing Image Serializers
4.3
Error Handling
4.4
Custom Serializers
4.5
Setting Cookies
4.5.1
Setting Unencrypted Cookies
4.5.2
Setting Encrypted Cookies
5
Runtime
5.1
Execution Model
5.2
Environments
5.3
Performance & Request Processing
5.4
Managing State
5.4.1
In-Memory
5.4.2
File System
5.4.3
Cookies
5.4.4
External Data Store
5.5
Exit Handlers
6
Security
6.1
Networking & Firewalls
6.2
Denial Of Service (DoS)
6.3
Sanitization & Injection
6.4
Cross-Origin Resource Sharing (CORS)
6.5
Cross-Site Request Forgery (CSRF, or XSRF)
6.6
Cookies
7
Hosting
7.1
DigitalOcean
7.2
RStudio Connect
7.3
Docker (Basic)
7.3.1
Default Dockerfile
7.3.2
Custom Dockerfiles
7.3.3
Automatically Run on Restart
7.4
Docker (Advanced)
7.4.1
Multiple Plumber Applications
7.4.2
Multiple Applications on One Port
7.4.3
Load Balancing
7.5
pm2
7.5.1
Server Deployment and Preparation
7.5.2
Install pm2
7.5.3
Wrap Your Plumber File
7.5.4
Introduce Our Service to pm2
7.5.5
Logs and Management
8
Programmatic Usage
8.1
Creating and Controlling a Router
8.2
Defining Endpoints
8.3
Defining Filters
8.4
Registering Hooks on a Router
8.5
Mounting & Static File Routers
8.6
Customizing a Router
9
Tips & Tricks
9.1
Debugging
9.1.1
Print Debugging
9.1.2
Interactive Debugging
9.2
Testing
9.3
Organizing Large Applications
9.4
Swagger
9.5
Performance
Appendix
A
All Annotations
B
Plumber 0.4.0 Migration Guide
C
Citations
Site hosting from Netlify
Creating APIs in R with Plumber
A
All Annotations