# Easy and Powerful Web Servers

## Documentation for package ‘plumber2’ version 0.2.0

- DESCRIPTION file
- User guides, package vignettes and other documentation
- Package NEWS
- Package README

## Help Pages

A B C F G I L M N O P R S

## -- A --

add_plumber2_tag | Add a tag extension to plumber2
all_opts | Retrieve options for creating a plumber2 api
api | Create a new plumber API, optionally based on one or more plumber files
api_add_route | Add a new route to either the request or header router
api_any | Add a handler for a request
api_any_header | Add a handler for a request header
api_assets | Serve resources from your file system
api_auth | Add auth to an endpoint
api_auth_guard | Add an auth guard to your API
api_connect | Add a handler for a request
api_connect_header | Add a handler for a request header
api_datastore | Persistent server-side data storage
api_delete | Add a handler for a request
api_delete_header | Add a handler for a request header
api_docs | Configure your API for serving documentation for itself
api_doc_add | Configure your API for serving documentation for itself
api_doc_setting | Configure your API for serving documentation for itself
api_forward | Set up a plumber2 api to act as a reverse proxy
api_get | Add a handler for a request
api_get_header | Add a handler for a request header
api_head | Add a handler for a request
api_head_header | Add a handler for a request header
api_logger | Set logging function and access log format for the API
api_message | Add a handler to a WebSocket message
api_off | Add a handler to an event
api_on | Add a handler to an event
api_options | Add a handler for a request
api_options_header | Add a handler for a request header
api_package | Load up an API distributed with a package
api_parse | Create a new plumber API, optionally based on one or more plumber files
api_patch | Add a handler for a request
api_patch_header | Add a handler for a request header
api_post | Add a handler for a request
api_post_header | Add a handler for a request header
api_put | Add a handler for a request
api_put_header | Add a handler for a request header
api_redirect | Redirect request to another resource
api_report | Serve Quarto and Rmarkdown documents from a plumber2 api
api_request_handlers | Add a handler for a request
api_request_header_handlers | Add a handler for a request header
api_run | Launch the API
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
api_session_cookie | Turn on session cookie data storage for your API
api_shiny | Serve a Shiny app from a plumber2 api
api_statics | Serve resources from your file system
api_stop | Launch the API
api_trace | Add a handler for a request
api_trace_header | Add a handler for a request header
async_evaluators | Async evaluators provided by plumber

## -- B --

Break | Router control flow

## -- C --

combined_log_format | Set logging function and access log format for the API
common_log_format | Set logging function and access log format for the API
create_server_yml | Create a _server.yml file to describe your API

## -- F --

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

## -- G --

get_async | Register an async evaluator
get_opts | Retrieve options for creating a plumber2 api
get_parsers | Register or fetch a parser
get_serializers | Register or fetch a serializer

## -- I --

is_plumber_api | Create a new plumber API, optionally based on one or more plumber files

## -- L --

logger_console | Set logging function and access log format for the API
logger_file | Set logging function and access log format for the API
logger_logger | Set logging function and access log format for the API
logger_null | Set logging function and access log format for the API
logger_otel | Set logging function and access log format for the API
logger_switch | Set logging function and access log format for the API

## -- M --

mirai_async | Async evaluators provided by plumber

## -- N --

Next | Router control flow

## -- O --

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

## -- P --

parsers | Parser functions provided by plumber2
parse_csv | Parser functions provided by plumber2
parse_feather | Parser functions provided by plumber2
parse_geojson | Parser functions provided by plumber2
parse_multipart | Parser functions provided by plumber2
parse_octet | Parser functions provided by plumber2
parse_parquet | Parser functions provided by plumber2
parse_rds | Parser functions provided by plumber2
parse_text | Parser functions provided by plumber2
parse_tsv | Parser functions provided by plumber2
parse_yaml | Parser functions provided by plumber2
Plumber2 | The Plumber2 Class

## -- R --

register_async | Register an async evaluator
register_parser | Register or fetch a parser
register_serializer | Register or fetch a serializer

## -- S --

serializers | Serializer functions provided by plumber2
should_break | Router control flow
show_registered_async | Register an async evaluator
show_registered_parsers | Register or fetch a parser
show_registered_serializers | Register or fetch a serializer