Swagger redirects to port 8080 when using BASE_URL #4385

maximelebastard · 2018-03-28T11:02:51Z

Q	A
Bug or feature request?	Bug
Which Swagger/OpenAPI version?	3
Which Swagger-UI version?	3.13.1/latest
How did you install Swagger-UI?	With the docker image, behind an nginx reverse proxy
Which browser & version?	Chrome, Safari...
Which operating system?	MacOS X

Configuration (browser query string, constructor, config.yaml)

Docker-compose.yml

version: '3.5'

services:
  gateway:
    build: ./nginx
    ports:
      - "80:80"
      - "443:443"
    links:
      - swaggerui

  swaggerui:
    image: swaggerapi/swagger-ui
    restart: always
    environment:
      - BASE_URL=/swagger

nginx.conf

# Documentation server
server {
    listen 443 ;

    include /etc/nginx/proxy.conf;
    include /etc/nginx/ssl.conf;

    location ^~ /swagger {
        proxy_pass              http://swaggerui:8080;
    }
}

curl -v http://doc.dev/swagger

*   Trying 127.0.0.1...
* TCP_NODELAY set
* Connected to doc.dev (127.0.0.1) port 80 (#0)
* Server auth using Basic with user 'test'
> GET /swagger HTTP/1.1
> Host: doc.dev
> User-Agent: curl/7.54.0
> Accept: */*
>
< HTTP/1.1 301 Moved Permanently
< Server: nginx
< Date: Wed, 28 Mar 2018 10:50:30 GMT
< Content-Type: text/html
< Content-Length: 185
< Connection: keep-alive
< Location: http://doc.dev:8080/swagger/
< Access-Control-Allow-Origin: *
< Access-Control-Allow-Methods: GET, POST, OPTIONS
< Access-Control-Allow-Headers: DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type
<
<html>
<head><title>301 Moved Permanently</title></head>
<body bgcolor="white">
<center><h1>301 Moved Permanently</h1></center>
<hr><center>nginx/1.10.3</center>
</body>
</html>
* Connection #0 to host doc.dev left intact

BUT when I add a final slash

curl -v http://doc.dev/swagger/
# I get the swagger app

Expected Behavior

It should work for http://doc.dev/swagger and http://doc.dev/swagger/ (with final slash) as well

Current Behavior

When not adding a final slash, we are redirected to 8080

Context

I have to explain this strange behavior to my teammates and to take care of the links I send.

shockey · 2018-10-24T21:18:27Z

@maximelebastard, I think this is an issue with your proxy setup - it should handle rewriting Swagger UI's URLs based on what your user is seeing.

Per this Server Fault answer, can you try changing your proxy_pass directive to:

        proxy_pass              http://swaggerui:8080/;

andreyhammer · 2019-03-18T14:56:15Z

Same issue. Without docker.

nginx config like:

location / {
proxy_pass http://example.com:80;
}

If i request https://example.com/swagger i get redirect to https://example.com:80/ui/swagger/ui/index

Please fix issue that was reported almost one year ago.

albernhagen · 2019-03-27T22:01:28Z

I also would like to see this issued fixed.

danielpsf · 2019-10-22T14:30:15Z

Almost killed myself because I thought it was my API Gateway that was doing this.

webron · 2019-10-22T16:52:02Z

@danielpsf please don't kill yourself over software, it's not worth it.

TLmaK0 · 2019-12-09T15:24:09Z

Add port_in_redirect off; to the location section. This will remove the port in the redirect.

As workaround for docker-compose you can use command to replace it and start nginx:

version: '3.5'

services:
  gateway:
    build: ./nginx
    ports:
      - "80:80"
      - "443:443"
    links:
      - swaggerui

  swaggerui:
    image: swaggerapi/swagger-ui
    restart: always
    environment:
      - BASE_URL=/swagger
    command: ['/bin/sh', '-c', 'sed -i "s|location \/ {|location \/ {\nport_in_redirect off;\n|g" /etc/nginx/nginx.conf && /usr/share/nginx/run.sh']

codesnipers · 2020-06-29T03:28:29Z

Add port_in_redirect off; to the location section. This will remove the port in the redirect.

As workaround for docker-compose you can use command to replace it and start nginx:

version: '3.5'

services:
  gateway:
    build: ./nginx
    ports:
      - "80:80"
      - "443:443"
    links:
      - swaggerui

  swaggerui:
    image: swaggerapi/swagger-ui
    restart: always
    environment:
      - BASE_URL=/swagger
    command: ['/bin/sh'. '-c', 'sed -i "s|location \/ {|location \/ {\nport_in_redirect off;\n|g" /etc/nginx/nginx.conf && /usr/share/nginx/run.sh']

not (.) -> (,) between sh and -c
command: ['/bin/sh', '-c', 'sed -i "s|location / {|location / {\nport_in_redirect off;\n|g" /etc/nginx/nginx.conf && /usr/share/nginx/run.sh']

ablankenship10 · 2020-11-14T20:28:20Z

I'm having the same issue and not using docker, just straight node locally. Why is it doing a redirect to /docs/ from /docs? Just load the content? Also this breaks things in a Lambda environment as the deployment stage is required after the baseUrl (e.g. https://host.com/dev/docs, it redirects to https://host.com/docs/)

shockey added type: bug P1 cat: docker labels Aug 28, 2018

shockey added type: support and removed P1 type: bug labels Oct 24, 2018

sibyaugustine mentioned this issue Jun 17, 2019

absolute_redirect off added in ngix config for avoiding port redirect #5409

Merged

17 tasks

xialiao mentioned this issue Jul 23, 2019

[BUG] Make rokwire api doc not going to 8080 rokwire/rokwire-building-blocks-api#97

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Swagger redirects to port 8080 when using BASE_URL #4385

Swagger redirects to port 8080 when using BASE_URL #4385

maximelebastard commented Mar 28, 2018

shockey commented Oct 24, 2018

andreyhammer commented Mar 18, 2019

albernhagen commented Mar 27, 2019

danielpsf commented Oct 22, 2019

webron commented Oct 22, 2019

TLmaK0 commented Dec 9, 2019 •

edited

Loading

codesnipers commented Jun 29, 2020

ablankenship10 commented Nov 14, 2020

Swagger redirects to port 8080 when using BASE_URL #4385

Swagger redirects to port 8080 when using BASE_URL #4385

Comments

maximelebastard commented Mar 28, 2018

Configuration (browser query string, constructor, config.yaml)

Expected Behavior

Current Behavior

Context

shockey commented Oct 24, 2018

andreyhammer commented Mar 18, 2019

albernhagen commented Mar 27, 2019

danielpsf commented Oct 22, 2019

webron commented Oct 22, 2019

TLmaK0 commented Dec 9, 2019 • edited Loading

codesnipers commented Jun 29, 2020

ablankenship10 commented Nov 14, 2020

TLmaK0 commented Dec 9, 2019 •

edited

Loading