Package index

Tidy API

While the R6 classes that are the foundation of routr allow you to manipulate and work with them directly through their class methods, it is often more convenient to use a functional and pipe-friendly interface.

route()

Construct a new route

route_stack()

Combine routes in a stack

route_add() route_remove() route_get()

Route handlers

route_merge()

Merge one route into another

Base Classes

A router based on routr is build up of Route objects combined together into a RouteStack object. Requests are passed through each route in a RouteStack and subjected to whatever handlers get matched to the URL at each step.

Route

Single route dispatch

RouteStack

Combine multiple routes for sequential routing

AssetRoute

Static file serving

Route constructors

A few predetermined route functionalities have constructors that help you create them easily.

asset_route()

High performance route for serving static files

ressource_route()

Create a route for fetching files

sizelimit_route()

Limit the size of requests

openapi_route()

Create a route for serving OpenAPI documentation of your server

report_route()

Create a route that renders and serves an Rmarkdown or Quarto report

shared_secret_route()

Reject requests not in possession of the correct shared secret