Klucz obcego pola znika w dokumentach przechwytujących po dodaniu atrybutu głębokości w Serializatorze

Question

Ilekroć definiuję atrybut depth, pole klucza obcego z dokumentu dokowania w sekcji POST znika. Wydaje się to dziwne, ponieważ wymagałem depth = 1, gdy chcę mieć powiązane dane w żądaniu . Nie mogę tego usunąć, aby uzyskać powiązany parametr pola w sekcji POST.

Oto przypadek.

Model:

from django.db import models 
from django.conf import settings 
# Create your models here. 

User = settings.AUTH_USER_MODEL 

class Todo(models.Model): 
    user = models.ForeignKey(User) 
    title = models.CharField("Title", max_length=255) 
    completed = models.BooleanField("Completed") 

serializer bez depth =1.

from rest_framework import serializers 
from models import Todo 

class TodoSerializer(serializers.HyperlinkedModelSerializer): 
    class Meta: 
     model = Todo 

wyjście Swagger:

Teraz Jeśli dodać depth = 1 niż Swagger nie wyświetla dziedzinie pokrewnej.

Daj mi znać, jeśli ktoś ma jakiekolwiek wskazówki na ten temat.

Dzięki :)

Answer 1

Musisz zaktualizować serialzer następująco

class TodoSerializer(serializers.HyperlinkedModelSerializer): 
creator = serializers.RelatedField(queryset=User.objects.all()) 

class Meta: 
    model = Todo 
    fields = ("name", "task", "creator") 
    depth = 1 

trzeba wspomina pól i RelatedField w swoim serializers

Answer 2

Wreszcie po wykopaniu do tego wymyślić rozwiązanie, dzięki któremu możemy uniknąć tego problemu i osiągnąć oczekiwane rozwiązanie.

Rozwiązaniem jest "Zamiast używać atrybutu depth = 1 możemy korzystać z podobnej instancji serializera, która działa podobnie do funkcji depth".

Oto sprawdzone rozwiązanie

modelu:

from django.db import models 
from django.conf import settings 

User = settings.AUTH_USER_MODEL 

class Todo(models.Model): 
    user = models.ForeignKey(User) 
    title = models.CharField("Title", max_length=255) 
    completed = models.BooleanField("Completed") 

serializer

from rest_framework import serializers 
from django.conf import settings 
from models import Todo 

User = settings.AUTH_USER_MODEL 


class UserSerializer(serializers.HyperlinkedSerializer): 
    class Meta: 
     model = User 


class TodoSerializer(serializers.HyperlinkedModelSerializer): 
    user = UserSerializer() 

    class Meta: 
     model = Todo 
     fields = ('user', 'title', 'completed') 

Swagger wyjściowy:

To rozwiązanie jest trochę inne podejście w celu osiągnięcia wymaganej funkcjonalności, ale spodziewam się oficjalnego rozwiązania z django-rest-swagger zespołu Nawet Pisałem tę samą kwerendę na django-rest-Swagger github repo here.