spotbest.blogg.se - Custom serializer django rest framework

CUSTOM SERIALIZER DJANGO REST FRAMEWORK UPDATE

Sometimes you can’t express the additional field you need this way.

The great thing about adding fields with queryset annotations is that it’s also efficient and prevents using an excessive number of SQL queries. Here I’m adding positions_count and transactions_count :Ĭlass AccountSerializer(serializers.

CUSTOM SERIALIZER DJANGO REST FRAMEWORK UPDATE

update the serializer to display new fields.

add a field based on the result SQL query, e.g.

Add fields on the fly that aren’t present on the modelĪnother common case I encountered while developing APIs was adding more data to the serialized model instances. You might want to mark those fields are read only instead of changing the serializer. If the only difference between serializers you have is that some fields are read only and shouldn’t be used in views that are updating the data,

override get_serializer_class (recommended!)īasename = "account" def get_serializer_class(self):.

reimplement each method you want to override the serializer for (repetitive).

fields that are computed based on more complex logic.

rich display of related fields for read only version.

Notice that there are less fields in the create form than within serialized values. This is often fine, but at times you want to do it differently. Serializers in drf allow easy serialization (e.g to json) and deserialization (to native python) in your API.īy default there is one serializer class for a single ViewSet, even if it contains multiple separate views. Different serializers for different methods within a viewset In this case I can assert that the user is indeed a User because I enforce that the user has to the authenticated with: Īssert isinstance(, User) is totally optional and done for the sake of narrowing down the type. Permission_classes = īasename = "account" def get_queryset(self) -> QuerySet:Īssert isinstance(self. The best place to filter the queryset is to override get_queryset method provided by the parent class.Ĭlass AccountsViewSet(viewsets.

private data visible only to the owning user.My app supports multiple users and they each have their own private data. Only show entities related to the current user I will provide a bit of a context, general motivation for using a given recipe and an example. They relate to a similar class of problems. The recipes are sorted from most common to more complex and are grouped together when If you want to know more about setting up typechecking for django rest framework I recommend this article. delete endpoint that in this case is very standardĮxamples are using python type hints and are coming from a project using python 3.8 (at the time of writing).create and update endpoints that only allow to set or touch limited number of parameters.very rich detail get endpoint ‘/accounts/id/’ for retrieving detailed account data that takes additional parameters (from_date, to_date).list endpoint ‘/accounts/’ that lists the accounts based on the model and provides a bunch of additional fields within each model.I’m using drf ViewSet to provide the following: The api is consumed by a react frontend and it’s customized by the need of the frontend app.

I’ve been working on a feature in the invertimo app where users can add multiple different investment accounts. This article doesn’t provide any introduction to django or the django rest framework. They all come from just a single ViewSet (set of related api endpoints)!Īt the end of the article I will show how all those bits fit together. Recipes from my use of django rest framework taken from my latest project. In this article I’m going to share a bunch of The documentation of django rest framework is pretty extensive, there is a great tutorial, api docs and plenty of examples.īut reality is usually a bit more complex and you need to customize your use of the framework. It’s easy to set up, extensible and saves so much time. One of my favorite tools in my app development toolkit is django rest framework (drf), that makes developing REST APIs with python and django easy and fun.

Unique together with a user that is not set in the form.

Use string value in an API for a field that has more efficient DB representation (enum).

Use a serializer for the query parameters.

Add fields on the fly that aren’t present on the model.

Different serializers for different methods within a viewset.

Only show entities related to the current user.