aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide
diff options
context:
space:
mode:
authorTom Christie2013-10-10 17:34:15 +0100
committerTom Christie2013-10-10 17:34:15 +0100
commitf18158358d99f94e2475821b1f3477dde0731bd7 (patch)
tree84ed0ffb3cbed0b08d7281e11ec99336df2b7b75 /docs/api-guide
parentc3e370b168de03b963b6afcffce6bd52e1d4ab7c (diff)
parent0bbc775b950d4ff7d3caef4fda719642ad792075 (diff)
downloaddjango-rest-framework-f18158358d99f94e2475821b1f3477dde0731bd7.tar.bz2
Merge branch 'master' of https://github.com/tomchristie/django-rest-framework
Diffstat (limited to 'docs/api-guide')
-rw-r--r--docs/api-guide/serializers.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md
index 6b91aa76..4c3fb9d3 100644
--- a/docs/api-guide/serializers.md
+++ b/docs/api-guide/serializers.md
@@ -67,6 +67,21 @@ At this point we've translated the model instance into Python native datatypes.
json
# '{"email": "leila@example.com", "content": "foo bar", "created": "2012-08-22T16:20:09.822"}'
+### Customizing field representation
+
+Sometimes when serializing objects, you may not want to represent everything exactly the way it is in your model.
+
+If you need to customize the serialized value of a particular field, you can do this by creating a `transform_<fieldname>` method. For example if you needed to render some markdown from a text field:
+
+ description = serializers.TextField()
+ description_html = serializers.TextField(source='description', read_only=True)
+
+ def transform_description_html(self, obj, value):
+ from django.contrib.markup.templatetags.markup import markdown
+ return markdown(value)
+
+These methods are essentially the reverse of `validate_<fieldname>` (see *Validation* below.)
+
## Deserializing objects
Deserialization is similar. First we parse a stream into Python native datatypes...