base_url issues in drf_yasg swagger

Question

I am running Django with Nginx in 8000 port. Here Nginx is exposed outside in 8000 port. But in Swagger UI the base_url is set as without port. So Swagger is trying to access endpoints without a port, then it gives a response as TypeError: Failed to fetch.

Kindly refer to the below image to know how base_url is set

Kindly refer to the below image to know how a request is sent from Swagger

When I access the endpoint (with port) using Postman it is working fine. The problem occurs only when I try using Swagger (because is sent a request without port).

Here I want Swagger to sent all the requests with the port. Please help me to resolve this issue. Thanks.

Note:

I'm using the drf-yasg==1.17.1 package to generate Swagger UI
Other requirements are Django==3.0.3 and djangorestframework==3.11.0

score 7 · Answer 1 · answered Nov 19 '20 at 11:09

7

You need to tell the Nginx to forward the server port as well. As swager gets the base url port from request header (if not hardcoded as mtshaikh proposed).

eg. something like this this should be in Nginx config

location / {
            proxy_set_header Host $host:$server_port;
    proxy_pass http://example.com:8000/;
}

answered Nov 19 '20 at 11:09

Petr Synek

323
2
7

Thanks for your answer and clue. I found the right solution and added a comment. – CHIDAMBARANATHAN M Nov 23 '20 at 11:22

score 1 · Answer 2 · answered Nov 15 '20 at 10:14

1

Not a good solution but defining the complete url in the get_schema_view() in urls.py works!

schema_view = get_schema_view(
    openapi.Info( ... ),
    url='http://example.net:8080/', # Important bit
    public=True,
    permission_classes=(permissions.AllowAny,)
)

Source

answered Nov 15 '20 at 10:14

mtshaikh

618
4
16

Thanks for your answer, @mtshaikh. It's working fine but is there any way to do this in an automatic way? – CHIDAMBARANATHAN M Nov 17 '20 at 05:43
AFAIK, there is an [open issue/discussion](https://github.com/axnsan12/drf-yasg/issues/491) on this functionality currently going on at the `drf_yasg` github. – mtshaikh Nov 17 '20 at 10:08
Little dirty, but it seems this is the only way. – MyounghoonKim Jun 29 '21 at 00:37

CHIDAMBARANATHAN M · Answer 3 · 2022-01-11T07:52:32.540

1

Thanks, @Petr Synek for your answer

We need to tell the Nginx to forward the http_host.

location / {
     proxy_set_header Host $http_host;
}

This one resolved the above-mentioned issue

edited Jan 11 '22 at 07:52

answered Nov 23 '20 at 11:28

CHIDAMBARANATHAN M

121
2
8

base_url issues in drf_yasg swagger

3 Answers3