Wagtail API v2 django.template.exceptions.TemplateDoesNotExist

Question

我已经按照docs的规定配置了Wagtail API，并且在使用curl时效果很好：

$ curl -LsD- http://127.0.0.1:8080/rest/p/
HTTP/1.1 200 OK
Date: Fri, 22 May 2020 17:33:58 GMT
Server: WSGIServer/0.2 CPython/3.8.2
Content-Type: application/json
Vary: Accept, Cookie
Allow: GET, HEAD, OPTIONS
X-Frame-Options: DENY
Content-Length: 433
X-Content-Type-Options: nosniff

{
    "meta": {
        "total_count": 1
    },
    "items": [
        {
            "id": 2,
            "meta": {
                "type": "wagtailcore.Page",
                "detail_url": "http://localhost/rest/p/2/",
                "html_url": "http://localhost/",
                "slug": "home",
                "first_published_at": null
            },
            "title": "Welcome to your new Wagtail site!"
        }
    ]
}

Wagtail文档规定以下内容：

可选，您可能还想将 rest_framework 添加到 INSTALLED_APPS 。从网络浏览器查看时，这将使该API可浏览，但基本JSON格式的输出不需要该API。

这是真的，因为API可以通过curl正常运行，但是如果我不将rest_framework添加到INSTALLED_APPS上，然后尝试通过浏览器访问相同的URL得到http 500，即因为应用程序引发异常：

Internal Server Error: /rest/p/
Traceback (most recent call last):
  File "/usr/local/lib/python3.8/site-packages/django/core/handlers/exception.py", line 34, in inner
    response = get_response(request)
  File "/usr/local/lib/python3.8/site-packages/django/core/handlers/base.py", line 145, in _get_response
    response = self.process_exception_by_middleware(e, request)
  File "/usr/local/lib/python3.8/site-packages/django/core/handlers/base.py", line 143, in _get_response
    response = response.render()
  File "/usr/local/lib/python3.8/site-packages/django/template/response.py", line 105, in render
    self.content = self.rendered_content
  File "/usr/local/lib/python3.8/site-packages/rest_framework/response.py", line 70, in rendered_content
    ret = renderer.render(self.data, accepted_media_type, context)
  File "/usr/local/lib/python3.8/site-packages/rest_framework/renderers.py", line 723, in render
    template = loader.get_template(self.template)
  File "/usr/local/lib/python3.8/site-packages/django/template/loader.py", line 19, in get_template
    raise TemplateDoesNotExist(template_name, chain=chain)
django.template.exceptions.TemplateDoesNotExist: rest_framework/api.html

所以在我看来，如果我不想在django例外情况下阻塞我的电子邮件，那么rest_framework是我的生产站点设置中的必备应用程序吗？我错过了一些配置细节吗？解决此问题的最佳方法是什么？

我不希望我的实时站点一直都在抛出500，而且我也严格不需要这个漂亮而闪亮的api接口。

---

编辑：

添加了相关的rest_framework配置：

REST_FRAMEWORK = {
    "DEFAULT_PERMISSION_CLASSES": [
        "rest_framework.permissions.IsAuthenticatedOrReadOnly",
    ],
    "DEFAULT_RENDERER_CLASSES": [
        "rest_framework.renderers.JSONRenderer",
    ],
}

---

编辑：

通过查看调试回溯，看来Wagtail正在某种程度上强制rest_framework.renderers.BrowsableAPIRenderer渲染器，即使REST_FRAMEWORK未配置为使用渲染器？

编辑：

显然Wagtail确实忽略了REST_FRAMEWORK设置，而是使用了[JSONRenderer, BrowsableAPIRenderer]的硬编码renderer_classes。

Answer 1

这是因为rest_framework将TemplateHTMLRenderer作为默认渲染器之一。

REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': [
       'rest_framework.renderers.JSONRenderer',
       'rest_framework.renderers.TemplateHTMLRenderer',
    ],
   ...
}

要渲染模板，必须使用Django模板util找到它们。对于要在rest_framework包中搜索模板的工具，必须将其添加到INSTALED_APPS中。

因此，要解决此问题，请覆盖REST_FRAMEWORK设置并删除TemplateHTMLRenderer，因为您只需要JSONRenderer。 您可以阅读有关DRF settings的更多信息。

Answer 2

可能是Wagtail中的bug ，因为它会忽略设置中的REST_FRAMEWORK配置，而是使用当前为{ {1}}。

要解决此问题，可以如下设置[JSONRenderer, BrowsableAPIRenderer]：

Wagtail API