Make HTML rendering of api views configurable through the settings mo…

…dule.
django-fiber · Aug 16, 2012 · d7ddc83 · d7ddc83
1 parent 00dd87d
commit d7ddc83
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 7 deletions.
diff --git a/docs/advanced-usage.rst b/docs/advanced-usage.rst
@@ -34,6 +34,8 @@ These settings are optional (default values are shown):
 
     COMPRESS = [the opposite of DEBUG]
 
+    API_RENDER_HTML = False  # If set to true, you must include 'djangorestframework' in installded apps as well
+
 
 Set or override fiber_page in the view:
 =======================================

diff --git a/fiber/app_settings.py b/fiber/app_settings.py
@@ -23,6 +23,8 @@
 METADATA_PAGE_SCHEMA = getattr(settings, 'FIBER_METADATA_PAGE_SCHEMA', {})
 METADATA_CONTENT_SCHEMA = getattr(settings, 'FIBER_METADATA_CONTENT_SCHEMA', {})
 
+API_RENDER_HTML = getattr(settings, 'API_RENDER_HTML', False)
+
 if 'fiber.middleware.PageFallbackMiddleware' in settings.MIDDLEWARE_CLASSES:
     raise DeprecationWarning( \
         "fiber.middleware.PageFallbackMiddleware has been removed.\n"

diff --git a/fiber/rest_api/views.py b/fiber/rest_api/views.py
@@ -7,11 +7,15 @@
 from djangorestframework.mixins import PaginatorMixin
 from djangorestframework.status import HTTP_400_BAD_REQUEST
 from djangorestframework.response import ErrorResponse
-from djangorestframework import renderers
+from djangorestframework.renderers import JSONRenderer, DocumentingHTMLRenderer
 
+from fiber.models import Page, PageContentItem
 from .forms import MovePageForm, MovePageContentItemForm
+from fiber.app_settings import API_RENDER_HTML
 
-from fiber.models import Page, PageContentItem
+API_RENDERERS = (JSONRenderer, )
+if API_RENDER_HTML:
+    API_RENDERERS = (JSONRenderer, DocumentingHTMLRenderer)
 
 
 class ApiRoot(View):
@@ -20,7 +24,7 @@ class ApiRoot(View):
     """
 
     permissions = (IsAuthenticated, )
-    renderers = (renderers.JSONRenderer, )
+    renderers = API_RENDERERS
 
     def get(self, request):
         return [
@@ -35,7 +39,7 @@ def get(self, request):
 class ListView(ListOrCreateModelView):
 
     permissions = (IsAuthenticated, )
-    renderers = (renderers.JSONRenderer, )
+    renderers = API_RENDERERS
 
 
 class TreeListView(View):
@@ -107,13 +111,13 @@ def get_queryset(self, *args, **kwargs):
 class InstanceView(InstanceModelView):
 
     permissions = (IsAuthenticated, )
-    renderers = (renderers.JSONRenderer, )
+    renderers = API_RENDERERS
 
 
 class MovePageView(View):
 
     permissions = (IsAuthenticated, )
-    renderers = (renderers.JSONRenderer, )
+    renderers = API_RENDERERS
 
     form = MovePageForm
 
@@ -130,7 +134,7 @@ def put(self, request, pk):
 class MovePageContentItemView(View):
 
     permissions = (IsAuthenticated, )
-    renderers = (renderers.JSONRenderer, )
+    renderers = API_RENDERERS
 
     form = MovePageContentItemForm