swagger (version 3.33.1)

plumber_docs: Plumber `register_doc()` information

Description

Normally documentation is registered in the `.onLoad()` method of the package. To avoid a circular dependency with `swagger` when `plumber` are starting up, `plumber` must retrieve this information manually on it's startup.

Usage

plumber_docs()

Details

See the examples for how documentation should regularly be registered.

Examples

# NOT RUN {
## Suggested setup for other packages trying to register visual docs for plumber
.onLoad <- function(...) {
  plumber_register_ui <- function() {
    tryCatch({
      do.call(plumber::register_ui, plumber_docs())
    }, error = function(e) {
      message("Error registering swagger docs. Error: ", e)
    })
  }

  setHook(packageEvent("plumber", "onLoad"), function(...) {
    plumber_register_ui()
  })
  if ("plumber" %in% loadedNamespaces()) {
    plumber_register_ui()
  }
}
# }