Add nested serializers support

Author: Ivaylo-Bachvarov-chichi

demo/project/organisations/serializers.py

@@ -27,3 +27,17 @@ class OrganisationDetailSerializer(serializers.ModelSerializer):
     class Meta:
         model = Organisation
         fields = ('name', 'slug', 'is_active')
+
+
+class MembershipSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Membership
+        fields = ('joined', 'is_owner', 'role')
+
+
+class RetrieveOrganisationSerializer(serializers.ModelSerializer):
+    membership_set = MembershipSerializer()
+
+    class Meta:
+        model = Organisation
+        fields = ('name', 'slug', 'is_active', 'membership_set')

demo/project/organisations/urls.py

@@ -5,6 +5,7 @@
 urlpatterns = [
 
     url(r'^create/$', view=views.CreateOrganisationView.as_view(), name="create"),
+    url(r'^(?P<slug>[\w-]+)/$', view=views.RetrieveOrganisationView.as_view(), name="organisation"),
     url(r'^(?P<slug>[\w-]+)/members/$', view=views.OrganisationMembersView.as_view(), name="members"),
     url(r'^(?P<slug>[\w-]+)/leave/$', view=views.LeaveOrganisationView.as_view(), name="leave")
 

demo/project/organisations/views.py

@@ -2,10 +2,18 @@
 from rest_framework.response import Response
 from project.organisations.models import Organisation, Membership
 from project.organisations.serializers import (
-    CreateOrganisationSerializer, OrganisationMembersSerializer
+    CreateOrganisationSerializer, OrganisationMembersSerializer, RetrieveOrganisationSerializer
 )
 
 
+class RetrieveOrganisationView(generics.RetrieveAPIView):
+
+    serializer_class = RetrieveOrganisationSerializer
+
+    def get_object(self):
+        pass
+
+
 class CreateOrganisationView(generics.CreateAPIView):
 
     serializer_class = CreateOrganisationSerializer

rest_framework_docs/api_endpoint.py

@@ -2,6 +2,7 @@
 import inspect
 from django.contrib.admindocs.views import simplify_regex
 from django.utils.encoding import force_str
+from rest_framework.serializers import BaseSerializer
 
 
 class ApiEndpoint(object):
@@ -16,8 +17,12 @@ def __init__(self, pattern, parent_pattern=None):
         self.allowed_methods = self.__get_allowed_methods__()
         # self.view_name = pattern.callback.__name__
         self.errors = None
-        self.fields = self.__get_serializer_fields__()
-        self.fields_json = self.__get_serializer_fields_json__()
+        self.serializer_class = self.__get_serializer_class__()
+        if self.serializer_class:
+            self.serializer = self.serializer_class()
+            self.fields = self.__get_serializer_fields__(self.serializer)
+            self.fields_json = self.__get_serializer_fields_json__()
+
         self.permissions = self.__get_permissions_class__()
 
     def __get_path__(self, parent_pattern):
@@ -35,23 +40,26 @@ def __get_permissions_class__(self):
         for perm_class in self.pattern.callback.cls.permission_classes:
             return perm_class.__name__
 
-    def __get_serializer_fields__(self):
-        fields = []
-        serializer = None
-
+    def __get_serializer_class__(self):
         if hasattr(self.callback.cls, 'serializer_class'):
-            serializer = self.callback.cls.serializer_class
+            return self.callback.cls.serializer_class
 
-        elif hasattr(self.callback.cls, 'get_serializer_class'):
-            serializer = self.callback.cls.get_serializer_class(self.pattern.callback.cls())
+        if hasattr(self.callback.cls, 'get_serializer_class'):
+            return self.callback.cls.get_serializer_class(self.pattern.callback.cls())
+
+    def __get_serializer_fields__(self, serializer):
+        fields = []
 
         if hasattr(serializer, 'get_fields'):
             try:
-                fields = [{
-                    "name": key,
-                    "type": str(field.__class__.__name__),
-                    "required": field.required
-                } for key, field in serializer().get_fields().items()]
+                for key, field in serializer.get_fields().items():
+                    sub_fields = self.__get_serializer_fields__(field) if isinstance(field, BaseSerializer) else None
+                    fields.append({
+                        "name": key,
+                        "type": str(field.__class__.__name__),
+                        "sub_fields": sub_fields,
+                        "required": field.required
+                    })
             except KeyError as e:
                 self.errors = e
                 fields = []

rest_framework_docs/templates/rest_framework_docs/components/fields_list.html

@@ -0,0 +1,14 @@
+<ul class="list fields">
+  {% for field in fields %}
+  <li class="field">
+    {{ field.name }}: {{ field.type }} 
+    {% if field.required %}
+      <span class="label label-primary label-required" title="Required">R</span>
+    {% endif %}
+
+    {% if field.sub_fields %}
+      {%include "rest_framework_docs/components/fields_list.html" with fields=field.sub_fields %}
+    {% endif %}
+  </li>
+  {% endfor %}
+</ul>

rest_framework_docs/templates/rest_framework_docs/home.html

@@ -65,11 +65,7 @@ <h4 class="panel-title title">
 
             {% if endpoint.fields %}
             <p class="fields-desc">Fields:</p>
-              <ul class="list fields">
-              {% for field in endpoint.fields %}
-                <li class="field">{{ field.name }}: {{ field.type }} {% if field.required %}<span class="label label-primary label-required" title="Required">R</span>{% endif %}</li>
-              {% endfor %}
-              </ul>
+              {%include "rest_framework_docs/components/fields_list.html" with fields=endpoint.fields %}
             {% elif not endpoint.errors %}
             <p>No fields.</p>
             {% endif %}