TL;DR: DRF は、最も外側のシリアライザーを検証するときに、内側のシリアル化されたオブジェクトを削除します。
私はdjango 2.0、django-rest-framework 3.7.7、python 3を使用しています。
POST で受信したいくつかのパラメーターを使用して、データベースで検索を実行する REST エンドポイントを構築したい (キャッシュされる可能性のある GET 呼び出しを避けたい)。パラメータは OR のように動作する必要があります (そのため、すべてのフィールドを必須ではないと設定しています) 。クエリセットを抽出するときにdjango Q クエリを使用して解決しています。
に次のdjangoモデルがありますapp/models.py
:
class Town(models.Model):
name = models.CharField(max_length=200)
province = models.CharField(max_length=2, blank=True, null=True)
zip = models.CharField(max_length=5)
country = models.CharField(max_length=100)
class Person(models.Model):
name = models.CharField(max_length=100)
birth_place = models.ForeignKey(Town, on_delete=models.SET_NULL,
null=True, blank=True,
related_name="birth_place_rev")
residence = models.ForeignKey(Town, on_delete=models.SET_NULL,
null=True, blank=True,
related_name="residence_rev")
そして、次のシリアライザーを に書きましたapp/serializers.py
。
class TownSerializer(serializers.ModelSerializer):
class Meta:
model = models.Town
fields = ("id", "name", "province", "zip", "country")
def __init__(self, *args, **kwargs):
super(TownSerializer, self).__init__(*args, **kwargs)
for field in self.fields:
self.fields[field].required = False
class PersonSerializer(serializers.ModelSerializer):
birth_place = TownSerializer(read_only=True)
residence = TownSerializer(read_only=True)
class Meta:
model = models.Person
fields = ("id", "name", "birth_place", "residence")
def __init__(self, *args, **kwargs):
super(PersonSerializer, self).__init__(*args, **kwargs)
for field in self.fields:
self.fields[field].required = False
次に、REST インターフェイスを提供するビューを次のように記述しましたapi/views.py
。
class PersonSearchList(views.APIView):
model_class = Person
serializer_class = PersonSerializer
permission_classes = (permissions.AllowAny,)
def post(self, request, format=None):
serializer = self.serializer_class(data=request.data)
print("initial_data", serializer.initial_data) ########
if serializer.is_valid():
self.data = serializer.validated_data
print(self.data) ########
queryset = self.get_queryset()
serialized_objects = self.serializer_class(queryset, many=True)
return Response(serialized_objects.data, status=status.HTTP_201_CREATED)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
def get_queryset(self, *args, **kwargs):
orig_queryset = self.model_class.objects.all()
query_payload = self.data
# .. perform filtering using the query_payload data.
return queryset
そして、たとえばcurlを使用してクエリを実行しようとすると:
$ curl -s -X POST -H "Content-Type: application/json" --data '{"birth_place": {"name": "Berlin", "country": "Germany"}}' http://127.0.0.1:8000/persons/ |python -m json.tool
[]
したがって、birth_place が設定された Person オブジェクトが作成されたばかりであってもです。ビューの post メソッドに配置した 2 つの print ステートメントは、次のように返します。
initial_data: {'birth_place': {'name': 'Berlin', 'country': 'Germany'}}
after is_valid: OrderedDict()
そのため、検証時に DRF がネストされたリレーションを削除するようです。
ネストされたリレーションも解析および検証するには、どのように指定すればよいですか? どんな提案でも大歓迎です。
PS: POST でリクエストを行うことで、間違った設計を強制していますか? 検索は冪等ではなく、人の機密データ (名前、姓、生年月日など) が含まれている可能性があるためだと思いました。安全な (検索でデータが変更されない) アクションが必要ですが、べき等ではありません (2 つの異なる時間での検索は異なる可能性があります)。
最初は generics.ListAPIView を使い始めましたが、list() は GET でしか機能しません。POST リクエストを受け入れるようにする方法があれば、魅力的に機能します。