plumber (version 1.0.0)

pr_set_docs_callback: Set the callback to tell where the API visual documentation is located

Description

When set, it will be called with a character string corresponding to the API visual documentation url. This allows RStudio to open swagger docs when a Plumber router pr_run() method.

Usage

pr_set_docs_callback(pr, callback = getOption("plumber.docs.callback", NULL))

Arguments

pr

A Plumber API. Note: The supplied Plumber API object will also be updated in place as well as returned by the function.

callback

a callback function for taking action on the docs url.

Value

The Plumber router with the new docs callback setting.

Details

If using options_plumber(), the value must be set before initializing your Plumber router.

Examples

# NOT RUN {
pr() %>%
  pr_set_docs_callback(function(url) { message("API location: ", url) }) %>%
  pr_get("/plus/<a:int>/<b:int>", function(a, b) { a + b }) %>%
  pr_run()
# }