Package index • plumber2

Create an run an API

api() is_plumber_api() api_parse(): Create a new plumber API, optionally based on one or more plumber files

api_package(): Load up an API distributed with a package

api_run() api_stop(): Launch the API

create_server_yml(): Create a _server.yml file to describe your API

Adding handlers and routes

api_get() api_head() api_post() api_put() api_delete() api_connect() api_options() api_trace() api_patch() api_any(): Add a handler for a request

api_get_header() api_head_header() api_post_header() api_put_header() api_delete_header() api_connect_header() api_options_header() api_trace_header() api_patch_header() api_any_header(): Add a handler for a request header

api_assets() api_statics(): Serve resources from your file system

api_message(): Add a handler to a WebSocket message

api_add_route(): Add a new route to either the request or header router

api_redirect(): Redirect request to another resource

api_shiny(): Serve a Shiny app from a plumber2 api

api_report(): Serve Quarto and Rmarkdown documents from a plumber2 api

api_forward(): Set up a plumber2 api to act as a reverse proxy

Parsers

register_parser() show_registered_parsers() get_parsers(): Register or fetch a parser

parse_csv() parse_octet() parse_rds() parse_feather() parse_parquet() parse_text() parse_tsv() parse_yaml() parse_geojson() parse_multipart(): Parser functions provided by plumber2

Serializers

register_serializer() show_registered_serializers() get_serializers(): Register or fetch a serializer

format_csv() format_tsv() format_rds() format_geojson() format_feather() format_parquet() format_yaml() format_htmlwidget() format_format() format_print() format_cat() format_unboxed() format_png() format_jpeg() format_tiff() format_svg() format_bmp() format_pdf(): Serializer functions provided by plumber2

Async evaluation

register_async() show_registered_async() get_async(): Register an async evaluator

mirai_async(): Async evaluators provided by plumber

Security

api_security_cors(): Set up CORS for a path in your plumber2 API

api_security_headers(): Add various security related headers to your plumber2 API

api_security_resource_isolation(): Set up resource isolation for a path

OpenAPI documentation

api_doc_setting() api_doc_add(): Configure your API for serving documentation for itself

openapi() openapi_info() openapi_contact() openapi_license() openapi_path() openapi_operation() openapi_parameter() openapi_header() openapi_schema() openapi_content() openapi_request_body() openapi_response() openapi_tag(): Construct OpenAPI specifications

Advanced

Plumber2: The Plumber2 Class

api_logger() logger_null() logger_console() logger_file() logger_logger() logger_otel() logger_switch() common_log_format combined_log_format: Set logging function and access log format for the API

api_on() api_off(): Add a handler to an event

api_session_cookie(): Turn on session cookie data storage for your API

api_datastore(): Persistent server-side data storage

api_auth(): Add auth to an endpoint

api_auth_guard(): Add an auth guard to your API

Next Break should_break(): Router control flow

add_plumber2_tag(): Add a tag extension to plumber2

apply_plumber2_block(): Generic for applying information from a plumber2 block to an api

get_opts() all_opts(): Retrieve options for creating a plumber2 api