Django REST Framework Cheat Sheet

Updated 2026-05-16

Next Topic: Event-Driven Backend Architecture Cheat Sheet

🧠Study flashcards on this topic106 cards · spaced repetition→

Django REST Framework (DRF) is a powerful and flexible toolkit for building Web APIs in Django, providing serialization of complex data types (models, querysets) into JSON/XML, authentication and permission systems, pagination, and browsable API interfaces. Built on top of Django's class-based views, DRF enables rapid API development through reusable components like ViewSets, Routers, and Serializers while maintaining full control over customization. One key insight: DRF's design philosophy favors explicit configuration over implicit behavior—understanding the distinction between Serializer vs ModelSerializer, APIView vs GenericAPIView vs ViewSet helps you choose the right abstraction level for each endpoint rather than defaulting to the highest-level shortcut every time.

What This Cheat Sheet Covers

This topic spans 30 focused tables and 163 indexed concepts, 106 flashcards. Below is a complete table-by-table outline of this topic, spanning foundational concepts through advanced details.

Table 1: Serializer ClassesTable 2: Serializer Field TypesTable 3: Serializer Field OptionsTable 4: Serializer ValidationTable 5: Nested Serializers & RelationsTable 6: Serializer MethodsTable 7: ViewSetsTable 8: ViewSet Actions & DecoratorsTable 9: Generic API ViewsTable 10: MixinsTable 11: Routers & URL ConfigurationTable 12: Authentication ClassesTable 13: Permission ClassesTable 14: Pagination StylesTable 15: Filtering & OrderingTable 16: Throttling ClassesTable 17: Request ObjectTable 18: Response ObjectTable 19: Status CodesTable 20: TestingTable 21: API Documentation (drf-spectacular)Table 22: ParsersTable 23: RenderersTable 24: Exception HandlingTable 25: API VersioningTable 26: CORS Configuration (django-cors-headers)Table 27: Settings ConfigurationTable 28: Performance OptimizationTable 29: Advanced Serializer FeaturesTable 30: Format Suffixes & Content Negotiation

Quick IndexSubscribe to unlock

A jump-to index of every table row in this cheat sheet.

Mind MapSubscribe to unlock

An interactive map of every table and concept in this topic.

Table 1: Serializer Classes

Serializers are the heart of DRF — they translate between Django objects and JSON in both directions. The choice here is mostly about how much you want written for you: a plain Serializer makes you declare every field, ModelSerializer infers them from a model, and HyperlinkedModelSerializer swaps primary keys for URLs. Pick the lowest-effort class that still gives you the control you need.

Class	Example	Description
Serializer	`class MySerializer(serializers.Serializer):` `name = serializers.CharField()` `age = serializers.IntegerField()`	• Base serializer requiring explicit field definitions • use for non-model data or full control over serialization logic
ModelSerializer	`class UserSerializer(serializers.ModelSerializer):` `class Meta:` `model = User` `fields = '__all__'`	• Automatically generates fields from a Django model • reduces boilerplate by inferring field types and validators
HyperlinkedModelSerializer	`class ArticleSerializer(serializers.HyperlinkedModelSerializer):` `class Meta:` `model = Article` `fields = ['url', 'title']`	• Uses hyperlinks instead of primary keys for relationships • requires `HyperlinkedRelatedField` and `request` in context
ListSerializer	`many=True` on any serializer `UserSerializer(queryset, many=True)`	• Handles serialization of multiple objects • automatically wraps serializer when `many=True` is used

Table 2: Serializer Field Types

Each field type both validates incoming data and shapes the output, so choosing the right one gives you correctness for free — EmailField rejects bad addresses, DecimalField keeps money exact, ImageField verifies an actual image. The last two rows are worth knowing early: SerializerMethodField lets you add computed read-only values, and HiddenField injects server-side data the client never sees.

Field	Example	Description
CharField	`title = serializers.CharField(max_length=100)`	• String field with max_length validation • maps to `<input type="text">` in browsable API

The rest of this section is part of the full cheat sheet

Table 3: Serializer Field Options

These keyword arguments fine-tune any field's behavior on input and output. The most consequential pair is read_only and write_only — together they let an id appear in responses but never be set, and a password be accepted but never returned. The rest control required-ness, null handling, defaults, and where a field's value actually comes from via source.

Option	Example	Description
read_only	`id = serializers.IntegerField(read_only=True)`	Field appears in output but cannot be set on create/update.

The rest of this section is part of the full cheat sheet

Table 4: Serializer Validation

DRF gives you three places to enforce rules: a validate_<field>() method for one field, a validate() method when fields depend on each other, and reusable validator classes attached to a field. Knowing which layer to use keeps validation logic where it belongs — cross-field checks like "start before end" belong in validate(), while uniqueness constraints map cleanly to UniqueValidator and UniqueTogetherValidator.

Method	Example	Description
validate_<field_name>()	`def validate_age(self, value):` `if value < 18:` `raise serializers.ValidationError("Must be 18+")` `return value`	• Field-level validation • called automatically for specific field

The rest of this section is part of the full cheat sheet

Table 1: Serializer Classes

Class	Example	Description
Serializer	`class MySerializer(serializers.Serializer):` `name = serializers.CharField()` `age = serializers.IntegerField()`	• Base serializer requiring explicit field definitions • use for non-model data or full control over serialization logic
ModelSerializer	`class UserSerializer(serializers.ModelSerializer):` `class Meta:` `model = User` `fields = '__all__'`	• Automatically generates fields from a Django model • reduces boilerplate by inferring field types and validators
HyperlinkedModelSerializer	`class ArticleSerializer(serializers.HyperlinkedModelSerializer):` `class Meta:` `model = Article` `fields = ['url', 'title']`	• Uses hyperlinks instead of primary keys for relationships • requires `HyperlinkedRelatedField` and `request` in context
ListSerializer	`many=True` on any serializer `UserSerializer(queryset, many=True)`	• Handles serialization of multiple objects • automatically wraps serializer when `many=True` is used

Table 2: Serializer Field Types

Field	Example	Description
CharField	`title = serializers.CharField(max_length=100)`	• String field with max_length validation • maps to `<input type="text">` in browsable API

Table 3: Serializer Field Options

Option	Example	Description
read_only	`id = serializers.IntegerField(read_only=True)`	Field appears in output but cannot be set on create/update.

Table 4: Serializer Validation

Method	Example	Description
validate_<field_name>()	`def validate_age(self, value):` `if value < 18:` `raise serializers.ValidationError("Must be 18+")` `return value`	• Field-level validation • called automatically for specific field