Manage nested serializer and list fields/serializers in Endpoint fields

demo/project/accounts/serializers.py

@@ -1,5 +1,6 @@
 from rest_framework import serializers
 from project.accounts.models import User
+from rest_framework.authtoken.serializers import AuthTokenSerializer
 
 
 class UserRegistrationSerializer(serializers.ModelSerializer):
@@ -30,3 +31,12 @@ class Meta:
  model = User
  fields = ('id', 'token', 'password',)
  extra_kwargs = {'password': {'write_only': True}}
+
+
+class NestedSerializer(serializers.Serializer):
+ nb_test = serializers.IntegerField(default=0, required=False)
+ liste_codes = serializers.ListField(child=serializers.CharField())
+
+
+class CustomAuthTokenSerializer(AuthTokenSerializer):
+ nested = NestedSerializer(many=True)

demo/project/accounts/views.py

@@ -2,13 +2,12 @@
 from django.views.generic.base import TemplateView
 from rest_framework import parsers, renderers, generics, status
 from rest_framework.authtoken.models import Token
-from rest_framework.authtoken.serializers import AuthTokenSerializer
 from rest_framework.permissions import AllowAny
 from rest_framework.response import Response
 from rest_framework.views import APIView
 from project.accounts.models import User
 from project.accounts.serializers import (
- UserRegistrationSerializer, UserProfileSerializer, ResetPasswordSerializer
+ UserRegistrationSerializer, UserProfileSerializer, ResetPasswordSerializer, CustomAuthTokenSerializer
 )
 
 
@@ -28,7 +27,7 @@ class LoginView(APIView):
  permission_classes = ()
  parser_classes = (parsers.FormParser, parsers.MultiPartParser, parsers.JSONParser,)
  renderer_classes = (renderers.JSONRenderer,)
- serializer_class = AuthTokenSerializer
+ serializer_class = CustomAuthTokenSerializer
 
  def post(self, request):
  serializer = self.serializer_class(data=request.data)

rest_framework_docs/api_endpoint.py

@@ -1,6 +1,7 @@
 import json
 import inspect
 from django.contrib.admindocs.views import simplify_regex
+from rest_framework import serializers
 from rest_framework.viewsets import ModelViewSet
 
 
@@ -50,11 +51,7 @@ def __get_serializer_fields__(self):
  serializer = self.callback.cls.serializer_class
  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()]
+ fields = self.__get_fields__(serializer)
  except KeyError as e:
  self.errors = e
  fields = []
@@ -64,6 +61,24 @@ def __get_serializer_fields__(self):
 
  return fields
 
+ def __get_fields__(self, serializer):
+ fields = []
+ for key, field in serializer().get_fields().items():
+ item = dict(
+ name=key,
+ type=str(field.__class__.__name__),
+ required=field.required
+ )
+ if isinstance(field, (serializers.ListSerializer, serializers.ListField)):
+ sub_type = field.child.__class__
+ item['sub_type'] = str(sub_type.__name__)
+ if isinstance(sub_type(), serializers.Serializer):
+ item['fields'] = self.__get_fields__(sub_type)
+ elif isinstance(field, serializers.Serializer):
+ item['fields'] = self.__get_fields__(field)
+ fields.append(item)
+ return fields
+
  def __get_serializer_fields_json__(self):
  # FIXME:
  # Return JSON or not?

rest_framework_docs/templates/rest_framework_docs/fields.html

@@ -0,0 +1,14 @@
+<ul class="list fields">
+ {% for field in item.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_type %} ({{ field.sub_type }}) {% endif %}
+ {% if field.fields %}
+ {% with field as item %}
+ {% include 'rest_framework_docs/fields.html' %}
+ {% endwith %}
+ {% endif %}
+ </li>
+ {% endfor %}
+</ul>

rest_framework_docs/templates/rest_framework_docs/home.html

@@ -65,14 +65,11 @@ <h4 class="panel-title title">
  {% if endpoint.errors %}
  <div class="alert alert-danger" role="alert">Oops! There was something wrong with {{ endpoint.errors }}. Please check your code.</div>
  {% endif %}
-
  {% 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>
+ {% with endpoint as item %}
+ {% include 'rest_framework_docs/fields.html' %}
+ {% endwith %}
  {% elif not endpoint.errors %}
  <p>No fields.</p>
  {% endif %}