Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
D
django-rest-framework
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
edx
django-rest-framework
Commits
19135061
Commit
19135061
authored
Feb 26, 2013
by
Tom Christie
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #681 from dbrgn/format_suffixes_docs
Added function type detail to format suffix docs
parents
d59ed649
bfdbc95f
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
12 additions
and
3 deletions
+12
-3
docs/api-guide/format-suffixes.md
+12
-3
No files found.
docs/api-guide/format-suffixes.md
View file @
19135061
...
@@ -35,12 +35,22 @@ Example:
...
@@ -35,12 +35,22 @@ Example:
urlpatterns = format_suffix_patterns(urlpatterns, allowed=['json', 'html'])
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 view
s. 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',))
@api_view(('GET',))
def api_root(request, format=None):
def api_root(request, format=None):
# do stuff...
# 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.
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.
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
...
@@ -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.
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
[
cite
]:
http://tech.groups.yahoo.com/group/rest-discuss/message/5857
[
cite2
]:
http://tech.groups.yahoo.com/group/rest-discuss/message/14844
[
cite2
]:
http://tech.groups.yahoo.com/group/rest-discuss/message/14844
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment