aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api-guide/serializers.md15
-rw-r--r--docs/topics/credits.md2
-rw-r--r--docs/tutorial/1-serialization.md2
3 files changed, 18 insertions, 1 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...
diff --git a/docs/topics/credits.md b/docs/topics/credits.md
index b5dce504..586bb0f0 100644
--- a/docs/topics/credits.md
+++ b/docs/topics/credits.md
@@ -170,6 +170,7 @@ The following people have helped make REST framework great.
* Ben Reilly - [bwreilly]
* Tai Lee - [mrmachine]
* Markus Kaiserswerth - [mkai]
+* Henry Clifford - [hcliff]
Many thanks to everyone who's contributed to the project.
@@ -376,3 +377,4 @@ You can also contact [@_tomchristie][twitter] directly on twitter.
[bwreilly]: https://github.com/bwreilly
[mrmachine]: https://github.com/mrmachine
[mkai]: https://github.com/mkai
+[hcliff]: https://github.com/hcliff
diff --git a/docs/tutorial/1-serialization.md b/docs/tutorial/1-serialization.md
index 22d29285..e1c0009c 100644
--- a/docs/tutorial/1-serialization.md
+++ b/docs/tutorial/1-serialization.md
@@ -225,7 +225,7 @@ For the moment we won't use any of REST framework's other features, we'll just w
We'll start off by creating a subclass of HttpResponse that we can use to render any data we return into `json`.
-Edit the `snippet/views.py` file, and add the following.
+Edit the `snippets/views.py` file, and add the following.
from django.http import HttpResponse
from django.views.decorators.csrf import csrf_exempt