Plumber: How to redirect from root to docs

Created on 30 Sep 2020 · 9Comments · Source: rstudio/plumber

Hi,

I'm currently working on an API (using plumber) inside a docker container and I would like to redirect to the __docs__ endpoint whenever the root endpoint is called. (e.g. redirect from https://localhost:8000/ to https://localhost:8000/__docs__)

Can you please tell me how it is possible to achieve this behavior using plumber?

Thank you very much in advance :)

knowledge question

Source

DODA-XXXL

Most helpful comment

You can do an http server rewrite with apache or nginx. I would ask over at RStudio Community. You could probably do it from plumber too using.

library(plumber)

#* @get /hello
function() {
  "Is it me you are looking for?"
}

#* @preempt __first__
#* @get /
function(req, res) {
  res$status <- 301 # redirect permanentl"y, or other 300 range http status code
  res$setHeader("Location", "./__docs__/")
  res$body <- "redirecting..."
  res
}

# If you want to remove / from API spec
#* @plumber
function(pr) {
  pr_set_api_spec(pr, function(spec) {
    spec$paths$`/` <- NULL
    spec
  })
}

Ask a Question
The issue tracker is not for general help questions -- please ask general plumber help questions on RStudio Community, https://community.rstudio.com/tag/plumber.

meztez on 30 Sep 2020

❤2 👍1

All 9 comments

You can do an http server rewrite with apache or nginx. I would ask over at RStudio Community. You could probably do it from plumber too using.

library(plumber)

#* @get /hello
function() {
  "Is it me you are looking for?"
}

#* @preempt __first__
#* @get /
function(req, res) {
  res$status <- 301 # redirect permanentl"y, or other 300 range http status code
  res$setHeader("Location", "./__docs__/")
  res$body <- "redirecting..."
  res
}

# If you want to remove / from API spec
#* @plumber
function(pr) {
  pr_set_api_spec(pr, function(spec) {
    spec$paths$`/` <- NULL
    spec
  })
}

Ask a Question
The issue tracker is not for general help questions -- please ask general plumber help questions on RStudio Community, https://community.rstudio.com/tag/plumber.

meztez on 30 Sep 2020

❤2 👍1

Note, this only works if forward = FALSE I believe in deployment.

muschellij2 on 30 Sep 2020

Not a redirect, but I just used:

#* @get /
#* @serializer html
function(){
  '<html><body><h1>Please visit the <a href="./__docs__/">docs page</a> for documentation</h1></body></html>'
}

for a landing page.

muschellij2 on 30 Sep 2020

I would add a redirect meta tag into the head of the html to auto redirect web browsers

Ex:

<html>
    <head>
        <meta http-equiv="refresh" content="0; url=./__docs__/" />
    </head>
    <body><h1>If not redirected, please visit the <a href="./__docs__/">docs page</a> for documentation</h1></body>
</html>

schloerke on 30 Sep 2020

Agree - that makes it better. What I meant by forwarding is that if you have forwarding on an just go to IPADDRESS, it'll show you IPADDRESS/APPLICATION, but when you use the redirect like that, it'll go to IPADDRESS/__docs__ not IPADDRESS/APPLICATION/__docs__. If you go to IPADDRESS/APPLICATION though, I think it's fine.

BTW - I think this only really happens in deployment (particularly with the configuration for DO), not a local build.

muschellij2 on 30 Sep 2020

@muschellij2 Ah, correct. I've updated https://github.com/rstudio/plumber/issues/682#issuecomment-701361493 above to redirect to ./__docs__/ and not ../__docs__/

schloerke on 30 Sep 2020

We have the same redirect in the package for /__swagger__/, could that be an issue?

https://github.com/rstudio/plumber/blob/43a7125113b05c5ff4cd84260ea95ff165d8bcd3/R/ui.R#L265

meztez on 30 Sep 2020

We have the same redirect in the package for /swagger/, could that be an issue?

@meztez No. The trailing slash in /__swagger__/ makes it act as if it's two layers (similar to /__swagger__/index.html). So if we're at that route, we'd like to go up one layer ('..') and into /__docs__/.

In @DODA-XXXL's situation, they are starting at the top level (/ or even /index.html).

schloerke on 1 Oct 2020

👍1

Thank you very much! The solution from @meztez works like a charm :)

DODA-XXXL on 1 Oct 2020

Was this page helpful?

0 / 5 - 0 ratings