如何在 drf_yasg 中将 Schemes 从 HTTP 更改为 HTTPS？

Question

我正在使用 drf_yasg 制作 swagger 文档。当我在 AWS Application Load Balancer 后面发布我的 DRF 应用程序并将侦听器设置为侦听 443 HTTPS 并重定向到 DRF 运行所在的 EC2 时，swagger UI 正在尝试向端点 http://example.com/status 而不是例如https://example.com/status。这会产生 Google Chrome 错误：

swagger-ui-bundle.js:71 Mixed Content: The page at 'https://example.com/swagger#/status/status_list' was loaded over HTTPS, but requested an insecure resource 'http://example.com/status'. This request has been blocked; the content must be served over HTTPS.

所以我解决这个问题的方法是在 drf_yasg.views.get_schema_view 中明确设置我的服务器 URL。所以我的代码看起来像：

schema_view = get_schema_view(
    openapi.Info(
        title="Server Api Documentation",
        default_version="v1",
        description="",
    url="http://example.com/status"
)

# noinspection PyUnresolvedReferences
swagger_patterns = [
    path("", schema_view.with_ui("swagger", cache_timeout=0), name="schema-swagger-ui"),

我希望能够不显式设置 URL 字符串，而是在 HTTP 或 HTTPS 之间选择方案。 drf_yasg可以吗？

Answer 1

将这些添加到您的 Django settings.py

# Setup support for proxy headers
USE_X_FORWARDED_HOST = True
SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')

Answer 2

如果您使用的是 nginx，请确保设置了正确的 header (X-Forwarded-Proto)。实际上，检查位于 end-user 和网络服务器（gunicorn / uwsgi）之间的所有 nginx 反向代理配置，如主机上的 nginx，例如nginx 部署在 docker.

location / {
    proxy_pass http://django:5000;
    proxy_set_header  Host              $http_host;
    proxy_set_header  X-Real-IP         $remote_addr;
    proxy_set_header  X-Forwarded-For   $proxy_add_x_forwarded_for;
    # check line below!
    proxy_set_header  X-Forwarded-Proto https;
    proxy_set_header  X-Forwarded-Referrer $http_referer;
    proxy_set_header  Referer $http_referer;
}

如何在 drf_yasg 中将 Schemes 从 HTTP 更改为 HTTPS？

How change Schemes from HTTP to HTTPS in drf_yasg?

python

django

django-rest-framework

openapi

drf-yasg