encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-08-04 20:40:14 +03:00
Code Issues Packages Projects Releases Wiki Activity

Change Tutorial 5 to use a class-based APIRootView

Browse Source
This commit is contained in:
Brad Erickson 2014-07-21 17:03:23 -07:00
parent 08772799d4
commit 742e08b074
1 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/tutorial/5-relationships-and-hyperlinked-apis.md
View File

@ -4,22 +4,21 @@ At the moment relationships within our API are represented by using primary keys
## Creating an endpoint for the root of our API ## Creating an endpoint for the root of our API
Right now we have endpoints for 'snippets' and 'users', but we don't have a single entry point to our API. To create one, we'll use a regular function-based view and the `@api_view` decorator we introduced earlier. Right now we have endpoints for 'snippets' and 'users', but we don't have a single entry point to our API. To create one, we'll use a class-based view:
from rest_framework import renderers from rest_framework.views import APIView
from rest_framework.decorators import api_view
from rest_framework.response import Response from rest_framework.response import Response
from rest_framework.reverse import reverse from rest_framework.reverse import reverse
@api_view(('GET',)) class APIRootView(APIView):
def api_root(request, format=None): def get(self, request, format=None):
return Response({ return Response({
'users': reverse('user-list', request=request, format=format), 'users': reverse('user-list', request=request, format=format),
'snippets': reverse('snippet-list', request=request, format=format) 'snippets': reverse('snippet-list', request=request, format=format)
}) })
Notice that we're using REST framework's `reverse` function in order to return fully-qualified URLs. Notice that we're using REST framework's `reverse` function in order to return fully-qualified URLs for 'user-list' and 'snippet-list' from urls.py.
## Creating an endpoint for the highlighted snippets ## Creating an endpoint for the highlighted snippets
@ -45,7 +44,7 @@ Instead of using a concrete generic view, we'll use the base class for represent
As usual we need to add the new views that we've created in to our URLconf. As usual we need to add the new views that we've created in to our URLconf.
We'll add a url pattern for our new API root: We'll add a url pattern for our new API root:
url(r'^$', 'api_root'), url(r'^$', views.APIRootView.as_view()),
And then add a url pattern for the snippet highlights: And then add a url pattern for the snippet highlights:
@ -109,7 +108,7 @@ After adding all those names into our URLconf, our final `'urls.py'` file should
# API endpoints # API endpoints
urlpatterns = format_suffix_patterns(patterns('snippets.views', urlpatterns = format_suffix_patterns(patterns('snippets.views',
url(r'^$', 'api_root'), url(r'^$', views.APIRootView.as_view()),
url(r'^snippets/$', url(r'^snippets/$',
views.SnippetList.as_view(), views.SnippetList.as_view(),
name='snippet-list'), name='snippet-list'),