Hosting swagger-ui behind nginx proxy

Question

we have a setup where we have deployed springdoc-openapi-starter-webmvc-ui with Spring Boot 3.1.5. The spring boot server is running on port 8080. We have setup nginx so that all requests that start with /api are forwarded to spring boot:

location ~ ^/api(/|$) {
        rewrite ^/api(/|$)(.*)$ /$2 break;
        proxy_pass http://127.0.0.1:8080;  # Forward requests to backend server
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; # per https://springdoc.org/index.html#how-can-i-deploy-springdoc-openapi-starter-webmvc-ui-behind-a-reverse-proxy
    proxy_set_header X-Forwarded-proto https; # per https://springdoc.org/index.html#how-can-i-deploy-springdoc-openapi-starter-webmvc-ui-behind-a-reverse-proxy
    proxy_set_header X-Forwarded-Prefix "/api"; # per https://springdoc.org/index.html#how-can-i-deploy-springdoc-openapi-starter-webmvc-ui-behind-a-reverse-proxy
    }

The last 3 lines are per what we could gather from this link. In our application.properties we have set:

server.forward-headers-strategy=NATIVE
server.use-forward-headers=true

Our expectation is that with this setup we should see the swagger UI at /api/swagger-ui/index.html. However when we navigate to that URL we see following:

and the developer tools in the browser show its trying to make request to /v3/api-docs to fetch the config whereas it should be making request to /api/v3/api-docs - we tested this URL works. All requests that Swagger UI is making to the backend need to be prefixed with /api. This is our core problem.

How can we fix this?

Vikrant · Accepted Answer · 2024-05-10 12:51:55Z

0

When our servers are behind proxy at that time we got this type of issue we have add below configuration in application.properties file.

server.forward-headers-strategy= framework

answered May 10, 2024 at 12:51

Vikrant

4473 silver badges10 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

morpheus · Accepted Answer · 2025-03-22 00:33:43Z

0

Managed to fix it and making note for self. The fix is to remove

rewrite ^/api(/|$)(.*)$ /$2 break;

from NGINX conf (i.e., don't rewrite the URL) and add following two properties to Spring boot application.properties:

server.servlet.contextPath=/api
server.forward-headers-strategy=framework

answered Mar 22 at 0:33

morpheus

20.7k29 gold badges115 silver badges193 bronze badges

Collectives™ on Stack Overflow

Hosting swagger-ui behind nginx proxy

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related