Package: plumber 1.2.1.9000

Barret Schloerke

plumber: An API Generator for R

Gives the ability to automatically generate and serve an HTTP API from R functions using the annotations in the R documentation around your functions.

Authors:Barret Schloerke [cre, aut], Jeff Allen [aut, ccp], Bruno Tremblay [ctb], Frans van Dunné [ctb], Sebastiaan Vandewoude [ctb], RStudio [cph, fnd]

plumber_1.2.1.9000.tar.gz
plumber_1.2.1.9000.zip(r-4.5)plumber_1.2.1.9000.zip(r-4.4)plumber_1.2.1.9000.zip(r-4.3)
plumber_1.2.1.9000.tgz(r-4.4-any)plumber_1.2.1.9000.tgz(r-4.3-any)
plumber_1.2.1.9000.tar.gz(r-4.5-noble)plumber_1.2.1.9000.tar.gz(r-4.4-noble)
plumber_1.2.1.9000.tgz(r-4.4-emscripten)plumber_1.2.1.9000.tgz(r-4.3-emscripten)
plumber.pdf |plumber.html
plumber/json (API)
NEWS

# Install plumber in R:
install.packages('plumber', repos = c('https://rstudio.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/rstudio/plumber/issues

On CRAN:

apiapi-serverplumber

99 exports 1.4k stars 10.09 score 20 dependencies 27 dependents

Last updated 2 months agofrom:7b3e025dfa34196ad9d438474d310bb39b05db91

Exports:%>%addSerializeras_attachmentavailable_apisdo_configure_httpsdo_deploy_apido_forwarddo_provisiondo_remove_apido_remove_forwardendpoint_serializerforwardget_character_setget_option_or_envgetCharacterSetinclude_fileinclude_htmlinclude_mdinclude_rmdis_plumberoptions_plumberparser_csvparser_featherparser_formparser_geojsonparser_jsonparser_multiparser_noneparser_octetparser_parquetparser_rdsparser_read_fileparser_textparser_tsvparser_yamlplumbplumb_apiplumberPlumberPlumberEndpointPlumberStaticprpr_cookiepr_deletepr_filterpr_getpr_handlepr_headpr_hookpr_hookspr_mountpr_postpr_putpr_runpr_set_404pr_set_api_specpr_set_debugpr_set_docspr_set_docs_callbackpr_set_errorpr_set_parserspr_set_serializerpr_staticrandom_cookie_keyregister_docsregister_parserregister_serializerregistered_docsregistered_parsersregistered_serializersserializer_bmpserializer_catserializer_content_typeserializer_csvserializer_deviceserializer_featherserializer_formatserializer_geojsonserializer_headersserializer_htmlserializer_htmlwidgetserializer_jpegserializer_jsonserializer_octetserializer_parquetserializer_pdfserializer_pngserializer_printserializer_rdsserializer_svgserializer_textserializer_tiffserializer_tsvserializer_unboxed_jsonserializer_write_fileserializer_yamlsession_cookiesessionCookievalidate_api_spec

Dependencies:clicrayoncurlellipsisfastmapgluehttpuvjsonlitelaterlifecyclemagrittrmimepromisesR6Rcpprlangsodiumstringiswaggerwebutils

Readme and manuals

Help Manual

Help pageTopics
Return an attachment responseas_attachment
Endpoint Serializer with Hooksendpoint_serializer
Forward Request to The Next Handlerforward
Request character setget_character_set
Send File Contents as Responseinclude_file include_html include_md include_rmd
Determine if Plumber objectis_plumber
Plumber optionsget_option_or_env options_plumber
Plumber Parsersparser_csv parser_feather parser_form parser_geojson parser_json parser_multi parser_none parser_octet parser_parquet parser_rds parser_read_file parser_text parser_tsv parser_yaml
Process a Plumber APIplumb
Process a Package's Plumber APIavailable_apis plumb_api
Package Plumber RouterPlumber
Plumber EndpointPlumberEndpoint
Static file routerPlumberStatic
plumber step R6 classPlumberStep
Create a new Plumber routerpr
Store session data in encrypted cookies.pr_cookie
Add a filter to Plumber routerpr_filter
Add handler to Plumber routerpr_delete pr_get pr_handle pr_head pr_post pr_put
Register a hookpr_hook pr_hooks
Mount a Plumber routerpr_mount
Start a server using 'plumber' objectpr_run
Set the handler that is called when the incoming request can't be servedpr_set_404
Set the OpenAPI Specificationpr_set_api_spec
Set debug value to include error messages of routes cause an errorpr_set_debug
Set the API visual documentationpr_set_docs
Set the 'callback' to tell where the API visual documentation is locatedpr_set_docs_callback
Set the error handler that is invoked if any filter or endpoint generates an errorpr_set_error
Set the default endpoint parsers for the routerpr_set_parsers
Set the default serializer of the routerpr_set_serializer
Add a static route to the 'plumber' objectpr_static
Random cookie key generatorrandom_cookie_key
Add visual documentation for plumber to useregistered_docs register_docs
Manage parsersregistered_parsers register_parser
Register a Serializerregistered_serializers register_serializer
Plumber Serializersserializer_bmp serializer_cat serializer_content_type serializer_csv serializer_device serializer_feather serializer_format serializer_geojson serializer_headers serializer_html serializer_htmlwidget serializer_jpeg serializer_json serializer_octet serializer_parquet serializer_pdf serializer_png serializer_print serializer_rds serializer_svg serializer_text serializer_tiff serializer_tsv serializer_unboxed_json serializer_write_file serializer_yaml
Store session data in encrypted cookies.session_cookie
Validate OpenAPI Specvalidate_api_spec