Always redirect /__swagger_/ to /__docs__/

NEWS.md

@@ -5,6 +5,8 @@ plumber 1.0.0.9999 Development version
 
 * When calling `Plumber$handle()` and defining a new `PlumberEndpoint`, `...` will be checked for invalid names #677  
 
+* `/__swagger__/` now always redirect to `/__docs__/`, even when Swagger isn't the selected interface. Use `options(plumber.legacyRedirects = FALSE)` to disable this behavior (. (@blairj09 #694)
+
 plumber 1.0.0
 --------------------------------------------------------------------------------
 

R/plumber-options.R

@@ -29,9 +29,12 @@
 #' \item{`plumber.sharedSecret`}{Shared secret used to filter incoming request.
 #' When `NULL`, secret is not validated. Otherwise, Plumber compares secret with http header
 #' `PLUMBER_SHARED_SECRET`. Failure to match results in http error 400. Defaults to `NULL`.}
+#' \item{`plumber.legacyRedirects`}{Plumber will redirect legacy route `/__swagger__/` and
+#' `/__swagger__/index.html` to `../__docs__/` and `../__docs__/index.html`. You can disable this
+#' by settings this option to `FALSE`. Defaults to `TRUE`}
 #' }
 #'
-#' @param port,docs,docs.callback,apiScheme,apiHost,apiPort,apiPath,apiURL,maxRequestSize,sharedSecret See details
+#' @param port,docs,docs.callback,apiScheme,apiHost,apiPort,apiPath,apiURL,maxRequestSize,sharedSecret,legacyRedirects See details
 #' @return
 #' The complete, prior set of [options()] values.
 #' If a particular parameter is not supplied, it will return the current value.
@@ -47,7 +50,8 @@ options_plumber <- function(
   apiPort              = getOption("plumber.apiPort"),
   apiPath              = getOption("plumber.apiPath"),
   maxRequestSize       = getOption("plumber.maxRequestSize"),
-  sharedSecret         = getOption("plumber.sharedSecret")
+  sharedSecret         = getOption("plumber.sharedSecret"),
+  legacyRedirects      = getOption("plumber.legacyRedirects")
 ) {
   options(
     plumber.apiScheme = apiScheme,
@@ -59,6 +63,7 @@ options_plumber <- function(
     plumber.port = port,
     plumber.sharedSecret = sharedSecret,
     plumber.docs = docs,
-    plumber.docs.callback = docs.callback
+    plumber.docs.callback = docs.callback,
+    plumber.legacyRedirects = legacyRedirects
   )
 }

R/ui.R

@@ -180,8 +180,6 @@ register_docs <- function(name, index, static = NULL) {
   stopifnot(is.function(index))
   if (!is.null(static)) stopifnot(is.function(static))
 
-  is_swagger <- isTRUE(name == "swagger")
-
   docs_root <- paste0("/__docs__/")
   docs_paths <- c("/index.html", "/")
 
@@ -213,12 +211,10 @@ register_docs <- function(name, index, static = NULL) {
 
     pr$mount(docs_root, docs_router)
 
-    # add legacy swagger redirects
-    if (is_swagger) {
-      redirect_info <- swagger_redirects()
-      for (path in names(redirect_info)) {
-        pr_get(pr, path, redirect_info[[path]])
-      }
+    # add legacy swagger redirects (RStudio Connect)
+    redirect_info <- swagger_redirects()
+    for (path in names(redirect_info)) {
+      pr_get(pr, path, redirect_info[[path]])
     }
 
     docs_url <- paste0(api_url, docs_root)
@@ -228,12 +224,11 @@ register_docs <- function(name, index, static = NULL) {
     pr$unmount(docs_root)
 
     # remove legacy swagger redirects
-    if (is_swagger) {
-      redirect_info <- swagger_redirects()
-      for (path in names(redirect_info)) {
-        pr$removeHandle("GET", path)
-      }
+    redirect_info <- swagger_redirects()
+    for (path in names(redirect_info)) {
+      pr$removeHandle("GET", path)
     }
+
     invisible()
   }
 
@@ -261,10 +256,14 @@ swagger_redirects <- function() {
       res
     }
   }
-  list(
-    "/__swagger__/" = to_route("../__docs__/"),
-    "/__swagger__/index.html"  = to_route("../__docs__/index.html")
-  )
+  if (isTRUE(getOption("plumber.legacyRedirects", TRUE))) {
+    list(
+      "/__swagger__/" = to_route("../__docs__/"),
+      "/__swagger__/index.html"  = to_route("../__docs__/index.html")
+    )
+  } else {
+    list()
+  }
 }