aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide/format-suffixes.md
diff options
context:
space:
mode:
authorTom Christie2013-02-26 11:49:09 -0800
committerTom Christie2013-02-26 11:49:09 -0800
commit19135061b629f33760af62f555944169a5eaba47 (patch)
tree523e404dc8731784597ad7f54e6ae0dbd592c18f /docs/api-guide/format-suffixes.md
parentd59ed6491535d8e3c2fb334835259326a6d0bc7c (diff)
parentbfdbc95f1a616da952da77cac31cd223a5554814 (diff)
downloaddjango-rest-framework-19135061b629f33760af62f555944169a5eaba47.tar.bz2
Merge pull request #681 from dbrgn/format_suffixes_docs
Added function type detail to format suffix docs
Diffstat (limited to 'docs/api-guide/format-suffixes.md')
-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