R/api.R

In cimentadaj/scrapex: Data package containing websites saved locally for web scraping examples

##' Launches an API in a new R process
##'
##' @param function_name the folder name where the plumber API is located. This should be in inst/plumber/
##' @param random_port a numeric value used as a port
##'
##' @return callr result of the individual R process
##' @author Jorge Cimentada
##'
##' @examples
##'
##' \dontrun{
##'   live_api <- launch_api("api_coveragedb")
##'   live_api$kill()
##' }
##'
launch_api <- function(function_name, random_port = NULL) {
  random_port <- if (is.null(random_port)) httpuv::randomPort() else random_port

  rp <- callr::r_bg(function(random_port, function_name) {

    api <- plumber::plumb_api("scrapex", function_name)

    api |>
      plumber::pr_set_docs("swagger") |>
      plumber::pr_set_api_spec(function(spec) {
        spec$components$securitySchemes$bearerAuth$type <- "http"
        spec$components$securitySchemes$bearerAuth$scheme <- "bearer"
        spec$components$securitySchemes$bearerAuth$bearerFormat <- "JWT"
        spec$security[[1]]$bearerAuth <- ""
        spec
      }) |>
      plumber::pr_set_debug(TRUE) |>
      plumber::pr_run(port = random_port)

  }, args = list(random_port = random_port, function_name = function_name))

  # Wait to launch the API
  Sys.sleep(5)

  api_web <- paste0("http://localhost:", random_port)
  print(paste0("Visit your REST API at ", api_web))
  print(paste0("Documentation is at ", api_web, "/__docs__/"))

  list(process = rp, api_web = api_web)
}

is_error <- function(expr) {
  res <- try(expr, silent = TRUE)
  bool <- class(res) == "try-error"
  list(is_error = bool, error_msg = res)
}