Package: plumber2 0.2.0.9000
plumber2: Easy and Powerful Web Servers
Automatically create a web server from annotated 'R' files or by building it up programmatically. Provides automatic 'OpenAPI' documentation, input handling, asynchronous evaluation, and plugin support.
Authors:
plumber2_0.2.0.9000.tar.gz
plumber2_0.2.0.9000.zip(r-4.7)plumber2_0.2.0.9000.zip(r-4.6)plumber2_0.2.0.9000.zip(r-4.5)
plumber2_0.2.0.9000.tgz(r-4.6-any)plumber2_0.2.0.9000.tgz(r-4.5-any)
plumber2_0.2.0.9000.tar.gz(r-4.7-any)plumber2_0.2.0.9000.tar.gz(r-4.6-any)
plumber2_0.2.0.9000.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
card.svg |card.png
plumber2/json (API)
NEWS
| # Install 'plumber2' in R: |
| install.packages('plumber2', repos = c('https://posit-dev.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/posit-dev/plumber2/issues
Pkgdown/docs site:https://plumber2.posit.co
Last updated from:b10bbd08f0. Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel-x86_64 | OK | 181 | ||
| source / vignettes | OK | 262 | ||
| linux-release-x86_64 | OK | 183 | ||
| macos-release-arm64 | OK | 167 | ||
| macos-oldrel-arm64 | OK | 122 | ||
| windows-devel | OK | 184 | ||
| windows-release | OK | 143 | ||
| windows-oldrel | OK | 142 | ||
| wasm-release | OK | 161 |
Exports:abort_bad_requestabort_conflictabort_forbiddenabort_goneabort_http_problemabort_internal_errorabort_method_not_allowedabort_not_acceptableabort_not_foundabort_statusabort_unauthorizedadd_plumber2_tagall_optsapiapi_add_routeapi_anyapi_any_headerapi_assetsapi_authapi_auth_guardapi_connectapi_connect_headerapi_datastoreapi_deleteapi_delete_headerapi_doc_addapi_doc_settingapi_forwardapi_getapi_get_headerapi_headapi_head_headerapi_loggerapi_messageapi_offapi_onapi_optionsapi_options_headerapi_packageapi_parseapi_patchapi_patch_headerapi_postapi_post_headerapi_putapi_put_headerapi_redirectapi_reportapi_runapi_security_corsapi_security_headersapi_security_resource_isolationapi_session_cookieapi_shinyapi_staticsapi_stopapi_traceapi_trace_headerapply_plumber2_blockBreakclean_formatterclose_formattercombined_log_formatcommon_log_formatcreate_server_ymlcspdevice_formatterformat_bmpformat_catformat_csvformat_featherformat_formatformat_geojsonformat_htmlwidgetformat_jpegformat_parquetformat_pdfformat_pngformat_printformat_rdsformat_svgformat_tiffformat_tsvformat_unboxedformat_yamlget_asyncget_optsget_parsersget_serializersinit_formatteris_plumber_apilogger_consolelogger_filelogger_loggerlogger_nulllogger_otellogger_switchmirai_asyncNextopenapiopenapi_contactopenapi_contentopenapi_headeropenapi_infoopenapi_licenseopenapi_operationopenapi_parameteropenapi_pathopenapi_request_bodyopenapi_responseopenapi_schemaopenapi_tagparse_csvparse_featherparse_geojsonparse_multipartparse_octetparse_parquetparse_plumber_fileparse_rdsparse_textparse_tsvparse_yamlPlumber2random_keyregister_asyncregister_parserregister_serializershould_breakshow_registered_asyncshow_registered_parsersshow_registered_serializersstswith_formatter
Dependencies:AsioHeadersaskpassbase64encbitbit64brewbriobrotlicallrclicliprcommonmarkcpp11crayoncurldescdigestevaluatefastmapfieryfireprooffiresafetyfiresalefirestormfsgluehighrhmshttpuvjosejsonliteknitrlaterlifecyclemagrittrmirainanonextopensslotelpillarpkgbuildpkgconfigpkgloadprettyunitsprocessxprogresspromisespsR6raggrapidocRcppreadrreqresrlangroutrroxygen2rprojrootsodiumstorrstringisvglitesyssystemfontstextshapingtibbletidyselecttriebeardtzdburltoolsutf8vctrsvroomwaysignwebsocketwebutilswithrxfunxml2yaml
_server.yml for framework developers
Rendered fromserver_yml.qmdusingquarto::htmlon May 21 2026.Last update: 2025-10-06
Started: 2025-10-06
Annotations reference
Rendered fromannotations.qmdusingquarto::htmlon May 21 2026.Last update: 2025-12-11
Started: 2025-03-21
Extending plumber2
Rendered fromextending.qmdusingquarto::htmlon May 21 2026.Last update: 2025-11-17
Started: 2025-09-22
Get Started
Rendered fromplumber.qmdusingquarto::htmlon May 21 2026.Last update: 2025-10-06
Started: 2025-04-02
Hosting
Rendered fromhosting.qmdusingquarto::htmlon May 21 2026.Last update: 2026-01-20
Started: 2025-03-21
Instrumentation with OpenTelemetry
Rendered fromotel.qmdusingquarto::htmlon May 21 2026.Last update: 2025-11-17
Started: 2025-10-09
Introduction
Rendered fromintroduction.qmdusingquarto::htmlon May 21 2026.Last update: 2025-09-05
Started: 2025-03-21
Programmatic Usage
Rendered fromprogrammatic-usage.qmdusingquarto::htmlon May 21 2026.Last update: 2025-08-08
Started: 2025-03-21
Rendering Output
Rendered fromrendering-output.qmdusingquarto::htmlon May 21 2026.Last update: 2025-10-06
Started: 2025-03-21
Routing & Input
Rendered fromrouting-and-input.qmdusingquarto::htmlon May 21 2026.Last update: 2026-01-21
Started: 2025-03-21
Runtime
Rendered fromexecution-model.qmdusingquarto::htmlon May 21 2026.Last update: 2025-09-22
Started: 2025-03-21
Security
Rendered fromsecurity.qmdusingquarto::htmlon May 21 2026.Last update: 2025-10-06
Started: 2025-03-21
Tips & Tricks
Rendered fromtips-and-tricks.qmdusingquarto::htmlon May 21 2026.Last update: 2025-08-08
Started: 2025-03-21
Upgrading From Plumber
Rendered frommigration.qmdusingquarto::htmlon May 21 2026.Last update: 2025-05-21
Started: 2025-03-21
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Add a tag extension to plumber2 | add_plumber2_tag |
| Create a new plumber API, optionally based on one or more plumber files | api api_parse is_plumber_api |
| Add a new route to either the request or header router | api_add_route |
| Serve resources from your file system | api_assets api_statics |
| Add auth to an endpoint | api_auth |
| Add an auth guard to your API | api_auth_guard |
| Persistent server-side data storage | api_datastore |
| Configure your API for serving documentation for itself | api_docs api_doc_add api_doc_setting |
| Set up a plumber2 api to act as a reverse proxy | api_forward |
| Set logging function and access log format for the API | api_logger combined_log_format common_log_format logger_console logger_file logger_logger logger_null logger_otel logger_switch |
| Add a handler to a WebSocket message | api_message |
| Add a handler to an event | api_off api_on |
| Load up an API distributed with a package | api_package |
| Redirect request to another resource | api_redirect |
| Serve Quarto and Rmarkdown documents from a plumber2 api | api_report |
| Add a handler for a request | api_any api_connect api_delete api_get api_head api_options api_patch api_post api_put api_request_handlers api_trace |
| Add a handler for a request header | api_any_header api_connect_header api_delete_header api_get_header api_head_header api_options_header api_patch_header api_post_header api_put_header api_request_header_handlers api_trace_header |
| Launch the API | api_run api_stop |
| Set up CORS for a path in your plumber2 API | api_security_cors |
| Add various security related headers to your plumber2 API | api_security_headers |
| Set up resource isolation for a path | api_security_resource_isolation |
| Turn on session cookie data storage for your API | api_session_cookie |
| Serve a Shiny app from a plumber2 api | api_shiny |
| Async evaluators provided by plumber | async_evaluators mirai_async |
| Create a _server.yml file to describe your API | create_server_yml |
| Retrieve options for creating a plumber2 api | all_opts get_opts |
| Router control flow | Break Next should_break |
| Construct OpenAPI specifications | openapi openapi_contact openapi_content openapi_header openapi_info openapi_license openapi_operation openapi_parameter openapi_path openapi_request_body openapi_response openapi_schema openapi_tag |
| Parser functions provided by plumber2 | parsers parse_csv parse_feather parse_geojson parse_multipart parse_octet parse_parquet parse_rds parse_text parse_tsv parse_yaml |
| The Plumber2 Class | Plumber2 |
| Register an async evaluator | get_async register_async show_registered_async |
| Register or fetch a parser | get_parsers register_parser show_registered_parsers |
| Register or fetch a serializer | get_serializers register_serializer show_registered_serializers |
| Serializer functions provided by plumber2 | format_bmp format_cat format_csv format_feather format_format format_geojson format_htmlwidget format_jpeg format_parquet format_pdf format_png format_print format_rds format_svg format_tiff format_tsv format_unboxed format_yaml serializers |
