Package: plumber 1.2.2.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:
plumber_1.2.2.9000.tar.gz
plumber_1.2.2.9000.zip(r-4.5)plumber_1.2.2.9000.zip(r-4.4)plumber_1.2.2.9000.zip(r-4.3)
plumber_1.2.2.9000.tgz(r-4.4-any)plumber_1.2.2.9000.tgz(r-4.3-any)
plumber_1.2.2.9000.tar.gz(r-4.5-noble)plumber_1.2.2.9000.tar.gz(r-4.4-noble)
plumber_1.2.2.9000.tgz(r-4.4-emscripten)plumber_1.2.2.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')) |
Bug tracker:https://github.com/rstudio/plumber/issues
Pkgdown site:https://www.rplumber.io
Last updated 2 months agofrom:c9d18e31c3. Checks:OK: 7. Indexed: yes.
| Target | Result | Date |
|---|---|---|
| Doc / Vignettes | OK | Dec 14 2024 |
| R-4.5-win | OK | Dec 14 2024 |
| R-4.5-linux | OK | Dec 14 2024 |
| R-4.4-win | OK | Dec 14 2024 |
| R-4.4-mac | OK | Dec 14 2024 |
| R-4.3-win | OK | Dec 14 2024 |
| R-4.3-mac | OK | Dec 14 2024 |
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_agg_jpegserializer_agg_pngserializer_agg_tiffserializer_bmpserializer_catserializer_content_typeserializer_csvserializer_deviceserializer_featherserializer_formatserializer_geojsonserializer_headersserializer_htmlserializer_htmlwidgetserializer_jpegserializer_jsonserializer_octetserializer_parquetserializer_pdfserializer_pngserializer_printserializer_rdsserializer_svgserializer_svgliteserializer_textserializer_tiffserializer_tsvserializer_unboxed_jsonserializer_write_fileserializer_yamlsession_cookiesessionCookievalidate_api_spec
Dependencies:clicrayoncurlfastmapgluehttpuvjsonlitelaterlifecyclemagrittrmimepromisesR6Rcpprlangsodiumstringiswaggerwebutils
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Return an attachment response | as_attachment |
| Endpoint Serializer with Hooks | endpoint_serializer |
| Forward Request to The Next Handler | forward |
| Request character set | get_character_set |
| Send File Contents as Response | include_file include_html include_md include_rmd |
| Determine if Plumber object | is_plumber |
| Plumber options | get_option_or_env options_plumber |
| Plumber Parsers | parser_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 API | plumb |
| Process a Package's Plumber API | available_apis plumb_api |
| Package Plumber Router | Plumber |
| Plumber Endpoint | PlumberEndpoint |
| Static file router | PlumberStatic |
| plumber step R6 class | PlumberStep |
| Create a new Plumber router | pr |
| Store session data in encrypted cookies. | pr_cookie |
| Add a filter to Plumber router | pr_filter |
| Add handler to Plumber router | pr_delete pr_get pr_handle pr_head pr_post pr_put |
| Register a hook | pr_hook pr_hooks |
| Mount a Plumber router | pr_mount |
| Start a server using 'plumber' object | pr_run |
| Set the handler that is called when the incoming request can't be served | pr_set_404 |
| Set the OpenAPI Specification | pr_set_api_spec |
| Set debug value to include error messages of routes cause an error | pr_set_debug |
| Set the API visual documentation | pr_set_docs |
| Set the 'callback' to tell where the API visual documentation is located | pr_set_docs_callback |
| Set the error handler that is invoked if any filter or endpoint generates an error | pr_set_error |
| Set the default endpoint parsers for the router | pr_set_parsers |
| Set the default serializer of the router | pr_set_serializer |
| Add a static route to the 'plumber' object | pr_static |
| Random cookie key generator | random_cookie_key |
| Add visual documentation for plumber to use | registered_docs register_docs |
| Manage parsers | registered_parsers register_parser |
| Register a Serializer | registered_serializers register_serializer |
| Plumber Serializers | serializer_agg_jpeg serializer_agg_png serializer_agg_tiff serializer_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_svglite serializer_text serializer_tiff serializer_tsv serializer_unboxed_json serializer_write_file serializer_yaml |
| Store session data in encrypted cookies. | session_cookie |
| Validate OpenAPI Spec | validate_api_spec |
