encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-25 19:14:01 +03:00
Code Issues Packages Projects Releases Wiki Activity

Stub out the documentation

Browse Source
This commit is contained in:
Tom Christie 2014-12-19 16:58:35 +00:00
parent 62f78dfbf1
commit 48d15f6ff8
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/api-guide/serializers.md
View File

@ -567,6 +567,32 @@ The inner `Meta` class on serializers is not inherited from parent classes by de
Typically we would recommend *not* using inheritance on inner Meta classes, but instead declaring all options explicitly.
## Advanced `ModelSerializer` usage
The ModelSerializer class also exposes an API that you can override in order to alter how serializer fields are automatically determined when instantiating the serializer.
#### `.serializer_field_mapping`
A mapping of Django model classes to REST framework serializer classes. You can override this mapping to alter the default serializer classes that should be used for each model class.
#### `.serializer_relational_field`
This property should be the serializer field class, that is used for relational fields by default. For `ModelSerializer` this defaults to `PrimaryKeyRelatedField`. For `HyperlinkedModelSerializer` this defaults to `HyperlinkedRelatedField`.
#### The build field methods
#### `build_standard_field(**kwargs)`
#### `build_relational_field(**kwargs)`
#### `build_nested_field(**kwargs)`
#### `build_property_field(**kwargs)`
#### `build_url_field(**kwargs)`
#### `build_unknown_field(**kwargs)`
---
# HyperlinkedModelSerializer