Adding nested serializers support for many=True relations

Author: i.donchev

.gitignore

@@ -11,5 +11,8 @@ drfdocs.egg-info/
 
 site/
 
+demo/node_modules/
+rest_framework_docs/static/rest_framework_docs/js/dist.min.js
+
 rest_framework_docs/static/node_modules/
 rest_framework_docs/static/rest_framework_docs/js/dist.min.js.map

demo/project/organisations/serializers.py

@@ -3,11 +3,18 @@
 from project.accounts.serializers import UserProfileSerializer
 
 
+class MembershipSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Membership
+        fields = ('joined', 'is_owner', 'role')
+
+
 class CreateOrganisationSerializer(serializers.ModelSerializer):
+    membership_set = MembershipSerializer(many=True)
 
     class Meta:
         model = Organisation
-        fields = ('name', 'slug',)
+        fields = ('name', 'slug', 'membership_set')
 
 
 class OrganisationMembersSerializer(serializers.ModelSerializer):
@@ -29,12 +36,6 @@ class Meta:
         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()
 

rest_framework_docs/api_endpoint.py

@@ -91,12 +91,20 @@ def __get_serializer_fields__(self, serializer):
 
         if hasattr(serializer, 'get_fields'):
             for key, field in serializer.get_fields().items():
-                sub_fields = self.__get_serializer_fields__(field) if isinstance(field, BaseSerializer) else None
+                to_many_relation = True if hasattr(field, 'many') else False
+                sub_fields = []
+
+                if to_many_relation:
+                    sub_fields = self.__get_serializer_fields__(field.child) if isinstance(field, BaseSerializer) else None
+                else:
+                    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
+                    "required": field.required,
+                    "to_many_relation": to_many_relation
                 })
             # FIXME:
             # Show more attibutes of `field`?

rest_framework_docs/static/rest_framework_docs/js/dist.min.js

@@ -6,6 +6,10 @@
       <span class="label label-primary label-required" title="Required">R</span>
     {% endif %}
 
+    {% if field.to_many_relation %}
+      <span class="label label-primary label-required" title="Required">many = True</span>
+    {% endif %}
+
     {% if field.sub_fields %}
       {%include "rest_framework_docs/components/fields_list.html" with fields=field.sub_fields %}
     {% endif %}