An API Generator for R


[Up] [Top]

Documentation for package ‘plumber’ version 1.2.2

Help Pages

as_attachment Return an attachment response
available_apis Process a Package's Plumber API
endpoint_serializer Endpoint Serializer with Hooks
forward Forward Request to The Next Handler
get_character_set Request character set
get_option_or_env Plumber options
include_file Send File Contents as Response
include_html Send File Contents as Response
include_md Send File Contents as Response
include_rmd Send File Contents as Response
is_plumber Determine if Plumber object
options_plumber Plumber options
parser_csv Plumber Parsers
parser_feather Plumber Parsers
parser_form Plumber Parsers
parser_geojson Plumber Parsers
parser_json Plumber Parsers
parser_multi Plumber Parsers
parser_none Plumber Parsers
parser_octet Plumber Parsers
parser_parquet Plumber Parsers
parser_rds Plumber Parsers
parser_read_file Plumber Parsers
parser_text Plumber Parsers
parser_tsv Plumber Parsers
parser_yaml Plumber Parsers
plumb Process a Plumber API
Plumber Package Plumber Router
PlumberEndpoint Plumber Endpoint
PlumberStatic Static file router
PlumberStep plumber step R6 class
plumb_api Process a Package's Plumber API
pr Create a new Plumber router
pr_cookie Store session data in encrypted cookies.
pr_delete Add handler to Plumber router
pr_filter Add a filter to Plumber router
pr_get Add handler to Plumber router
pr_handle Add handler to Plumber router
pr_head Add handler to Plumber router
pr_hook Register a hook
pr_hooks Register a hook
pr_mount Mount a Plumber router
pr_post Add handler to Plumber router
pr_put Add handler to Plumber router
pr_run Start a server using 'plumber' object
pr_set_404 Set the handler that is called when the incoming request can't be served
pr_set_api_spec Set the OpenAPI Specification
pr_set_debug Set debug value to include error messages of routes cause an error
pr_set_docs Set the API visual documentation
pr_set_docs_callback Set the 'callback' to tell where the API visual documentation is located
pr_set_error Set the error handler that is invoked if any filter or endpoint generates an error
pr_set_parsers Set the default endpoint parsers for the router
pr_set_serializer Set the default serializer of the router
pr_static Add a static route to the 'plumber' object
random_cookie_key Random cookie key generator
registered_docs Add visual documentation for plumber to use
registered_parsers Manage parsers
registered_serializers Register a Serializer
register_docs Add visual documentation for plumber to use
register_parser Manage parsers
register_serializer Register a Serializer
serializer_bmp Plumber Serializers
serializer_cat Plumber Serializers
serializer_content_type Plumber Serializers
serializer_csv Plumber Serializers
serializer_device Plumber Serializers
serializer_feather Plumber Serializers
serializer_format Plumber Serializers
serializer_geojson Plumber Serializers
serializer_headers Plumber Serializers
serializer_html Plumber Serializers
serializer_htmlwidget Plumber Serializers
serializer_jpeg Plumber Serializers
serializer_json Plumber Serializers
serializer_octet Plumber Serializers
serializer_parquet Plumber Serializers
serializer_pdf Plumber Serializers
serializer_png Plumber Serializers
serializer_print Plumber Serializers
serializer_rds Plumber Serializers
serializer_svg Plumber Serializers
serializer_text Plumber Serializers
serializer_tiff Plumber Serializers
serializer_tsv Plumber Serializers
serializer_unboxed_json Plumber Serializers
serializer_write_file Plumber Serializers
serializer_yaml Plumber Serializers
session_cookie Store session data in encrypted cookies.
validate_api_spec Validate OpenAPI Spec