如何使用 drf-yasg 自动生成的招摇页面配置“HTTPS”方案？

Question

我知道在传统的招摇 YAML 文件中，我们可以使用以下方式定义方案：

schemes:
  - http
  - https

//OR

schemes: [http, https]

但是，如何使用drf-yasg库对自动生成的招摇页面做同样的事情？

现在，生成的 swagger 页面只包含HTTP方案，但缺少HTTPS 。 我尝试将setting.py中的DEFAULT_API_URL设置为https://mybaseurl.com ，但它似乎不起作用。

Answer 1

有一个解决方案。

在urls.py中定义 get_schema_view() 时，使用以下代码：

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

注意：您可以使用 https 或 http，因为这样可以更好地将此解决方案与环境变量一起用于不同的设置。

Answer 2

要在 swagger 中同时使用http和https方案，您可以从drf_yasg.generators OpenAPISchemaGenerator

class BothHttpAndHttpsSchemaGenerator(OpenAPISchemaGenerator):
    def get_schema(self, request=None, public=False):
        schema = super().get_schema(request, public)
        schema.schemes = ["http", "https"]
        return schema

所以现在你可以将它用作get_schema_view()的generator_class

schema_view = get_schema_view(
    openapi.Info( ... ),
    public=True,
    generator_class=BothHttpAndHttpsSchemaGenerator, # Here
    permission_classes=(AllowAny,)
)

Answer 3

放

url='https://your_server_address/'

在带有 URL 的 get_schema_view() 函数中。

Answer 4

在 swagger 页面中使用https方案的另一种方法是使用SECURE_PROXY_SSL_HEADER配置。

假设您的 Django REST API 位于执行 SSL 终止的Nginx后面，您可以让 Nginx 将X-Forwarded-Proto: https到您的 Django 应用程序（默认情况下，Nginx 可能已经转发此标头，具体取决于您的设置方式）。 通过以下配置，您的 Django 应用程序将意识到它位于 SSL 终止 Nginx 的后面，并且 Django 的内部函数is_secure()将在标头存在时返回True 。 请参阅 Django SSL 设置。

一旦is_secure()返回True ，swagger 页面方案将自动变为https 。

SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')

我喜欢这种方法，因为它不需要任何硬编码 url，甚至不需要从环境变量配置 url。 此外， is_secure()函数也在其他地方内部使用，因此希望该函数按理想状态工作。