aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDanilo Bargen2013-02-26 10:30:42 +0100
committerDanilo Bargen2013-02-26 10:30:42 +0100
commitbfdbc95f1a616da952da77cac31cd223a5554814 (patch)
tree72786b70cb7c00d739e921814a987e46df22ff31
parent8da83f0df9761550cbcac88850a659aab00a2506 (diff)
downloaddjango-rest-framework-bfdbc95f1a616da952da77cac31cd223a5554814.tar.bz2
Added CBV example to format-suffixes docs
-rw-r--r--docs/api-guide/format-suffixes.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/docs/api-guide/format-suffixes.md b/docs/api-guide/format-suffixes.md
index 6d5feba4..02fa1810 100644
--- a/docs/api-guide/format-suffixes.md
+++ b/docs/api-guide/format-suffixes.md
@@ -35,12 +35,22 @@ Example:
urlpatterns = format_suffix_patterns(urlpatterns, allowed=['json', 'html'])
-When using `format_suffix_patterns`, you must make sure to add the `'format'` keyword argument to the corresponding views. For example.
+When using `format_suffix_patterns`, you must make sure to add the `'format'` keyword argument to the corresponding view. For example:
@api_view(('GET',))
def api_root(request, format=None):
# do stuff...
+Or with class based views:
+
+ class CommentList(APIView):
+
+ def get(self, request, format=None):
+ # do stuff...
+
+ def post(self, request, format=None):
+ # do stuff...
+
The name of the kwarg used may be modified by using the `FORMAT_SUFFIX_KWARG` setting.
Also note that `format_suffix_patterns` does not support descending into `include` URL patterns.
@@ -58,4 +68,4 @@ It is actually a misconception. For example, take the following quote from Roy
The quote does not mention Accept headers, but it does make it clear that format suffixes should be considered an acceptable pattern.
[cite]: http://tech.groups.yahoo.com/group/rest-discuss/message/5857
-[cite2]: http://tech.groups.yahoo.com/group/rest-discuss/message/14844 \ No newline at end of file
+[cite2]: http://tech.groups.yahoo.com/group/rest-discuss/message/14844