验证 Swagger API 文档 (drf-yasg)

Question

我已经设置 DRF-YASG 但我无法弄清楚如何配置它以显示需要身份验证的视图。

配置如下

  schema_view = get_schema_view(
      openapi.Info(
        title="Swagger Doc",
        default_version='v1',
        description="Test description",
        terms_of_service="https://www.google.com/policies/terms/",
        contact=openapi.Contact(email="contact@snippets.local"),
        license=openapi.License(name="BSD License"),
      ),
      validators=['flex', 'ssv'],
      permission_classes=(permissions.AllowAny,),  # If I change the permission it throws an exception. See below
      public=False,
      patterns=public_apis,
  )

public_apis 是我希望人们在通过身份验证后看到的 API。

如上配置，不显示单个API。它仅显示 Authorize 按钮和显示 No operations defined in spec! 的文本。但是如果我将 public=False 更改为 public=True 那么它会显示所有 APIs.

PS：之前我使用的是 Django Rest Swagger，我能够将其配置为仅在提供 JWT 令牌后才显示 API。

我正在使用 JWT 进行身份验证。

权限更改异常：

另一个问题是，如果我将上述权限更改为 DRF 权限 class，渲染将失败并出现以下错误：

  Internal Server Error: /swagger/
  Traceback (most recent call last):
    File "/usr/local/lib/python3.6/site-packages/django/core/handlers/exception.py", line 41, in inner
      response = get_response(request)
    File "/usr/local/lib/python3.6/site-packages/django/core/handlers/base.py", line 217, in _get_response
      response = self.process_exception_by_middleware(e, request)
    File "/usr/local/lib/python3.6/site-packages/django/core/handlers/base.py", line 215, in _get_response
      response = response.render()
    File "/usr/local/lib/python3.6/site-packages/django/template/response.py", line 107, in render
      self.content = self.rendered_content
    File "/usr/local/lib/python3.6/site-packages/rest_framework/response.py", line 72, in rendered_content
      ret = renderer.render(self.data, accepted_media_type, context)
    File "/usr/local/lib/python3.6/site-packages/drf_yasg/renderers.py", line 54, in render
      self.set_context(renderer_context, swagger)
    File "/usr/local/lib/python3.6/site-packages/drf_yasg/renderers.py", line 62, in set_context
      renderer_context['title'] = swagger.info.title
  AttributeError: 'dict' object has no attribute 'info'
  Internal Server Error: /swagger/

我尝试将其更改为 permmissions.IsAuthenticated 和我自己的自定义权限 classes 但它们都失败并出现相同的错误。

Answer 1

原来问题是我在 DRF 的 DEFAULT_AUTHENTICATION_CLASSES 中缺少 rest_framework.authentication.SessionAuthentication。

所以通过Django Admin登录视图登录后发送的请求对象没有用户，所以所有权限类一直失败，然后会导致上述错误。

所以在添加它之后 drf-yasg 显示了它所有的荣耀。

错误：

虽然发生这种情况时抛出的错误是作为错误提出的。参见 #issue58。

验证 Swagger API 文档 (drf-yasg)

Authenticating Swagger API docs (drf-yasg)

django

django-rest-framework

drf-yasg