aboutsummaryrefslogtreecommitdiffstats
path: root/examples/sandbox/views.py
diff options
context:
space:
mode:
authorTom Christie2012-02-21 20:12:14 +0000
committerTom Christie2012-02-21 20:12:14 +0000
commitaf9e4f69d732cc643d6ec7ae13d4a19ac0332d44 (patch)
tree9d3fb9a8aebc520716e7f83075ef83e8102b5952 /examples/sandbox/views.py
parent21fcd3a90631e96e3fa210dd526abab9571ad6e1 (diff)
downloaddjango-rest-framework-af9e4f69d732cc643d6ec7ae13d4a19ac0332d44.tar.bz2
Merging master into develop
Diffstat (limited to 'examples/sandbox/views.py')
-rw-r--r--examples/sandbox/views.py65
1 files changed, 46 insertions, 19 deletions
diff --git a/examples/sandbox/views.py b/examples/sandbox/views.py
index 49b59b40..34216ad2 100644
--- a/examples/sandbox/views.py
+++ b/examples/sandbox/views.py
@@ -1,40 +1,67 @@
"""The root view for the examples provided with Django REST framework"""
-from django.core.urlresolvers import reverse
+from djangorestframework.utils import reverse
from djangorestframework.views import View
from djangorestframework.response import Response
class Sandbox(View):
- """This is the sandbox for the examples provided with [Django REST framework](http://django-rest-framework.org).
+ """
+ This is the sandbox for the examples provided with
+ [Django REST framework][1].
- These examples are provided to help you get a better idea of some of the features of RESTful APIs created using the framework.
+ These examples are provided to help you get a better idea of some of the
+ features of RESTful APIs created using the framework.
- All the example APIs allow anonymous access, and can be navigated either through the browser or from the command line...
+ All the example APIs allow anonymous access, and can be navigated either
+ through the browser or from the command line.
- bash: curl -X GET http://api.django-rest-framework.org/ # (Use default renderer)
- bash: curl -X GET http://api.django-rest-framework.org/ -H 'Accept: text/plain' # (Use plaintext documentation renderer)
+ For example, to get the default representation using curl:
+
+ bash: curl -X GET http://rest.ep.io/
+
+ Or, to get the plaintext documentation represention:
+
+ bash: curl -X GET http://rest.ep.io/ -H 'Accept: text/plain'
The examples provided:
- 1. A basic example using the [Resource](http://django-rest-framework.org/library/resource.html) class.
- 2. A basic example using the [ModelResource](http://django-rest-framework.org/library/modelresource.html) class.
- 3. An basic example using Django 1.3's [class based views](http://docs.djangoproject.com/en/dev/topics/class-based-views/) and djangorestframework's [RendererMixin](http://django-rest-framework.org/library/renderers.html).
+ 1. A basic example using the [Resource][2] class.
+ 2. A basic example using the [ModelResource][3] class.
+ 3. An basic example using Django 1.3's [class based views][4] and
+ djangorestframework's [RendererMixin][5].
4. A generic object store API.
5. A code highlighting API.
6. A blog posts and comments API.
7. A basic example using permissions.
8. A basic example using enhanced request.
- Please feel free to browse, create, edit and delete the resources in these examples."""
+ Please feel free to browse, create, edit and delete the resources in
+ these examples.
+
+ [1]: http://django-rest-framework.org
+ [2]: http://django-rest-framework.org/library/resource.html
+ [3]: http://django-rest-framework.org/library/modelresource.html
+ [4]: http://docs.djangoproject.com/en/dev/topics/class-based-views/
+ [5]: http://django-rest-framework.org/library/renderers.html
+ """
def get(self, request):
- return Response([{'name': 'Simple Resource example', 'url': reverse('example-resource')},
- {'name': 'Simple ModelResource example', 'url': reverse('model-resource-root')},
- {'name': 'Simple Mixin-only example', 'url': reverse('mixin-view')},
- {'name': 'Object store API', 'url': reverse('object-store-root')},
- {'name': 'Code highlighting API', 'url': reverse('pygments-root')},
- {'name': 'Blog posts API', 'url': reverse('blog-posts-root')},
- {'name': 'Permissions example', 'url': reverse('permissions-example')},
- {'name': 'Simple request mixin example', 'url': reverse('request-example')}
- ])
+ return Response([
+ {'name': 'Simple Resource example',
+ 'url': reverse('example-resource', request)},
+ {'name': 'Simple ModelResource example',
+ 'url': reverse('model-resource-root', request)},
+ {'name': 'Simple Mixin-only example',
+ 'url': reverse('mixin-view', request)},
+ {'name': 'Object store API'
+ 'url': reverse('object-store-root', request)},
+ {'name': 'Code highlighting API',
+ 'url': reverse('pygments-root', request)},
+ {'name': 'Blog posts API',
+ 'url': reverse('blog-posts-root', request)},
+ {'name': 'Permissions example',
+ 'url': reverse('permissions-example', request)},
+ {'name': 'Simple request mixin example',
+ 'url': reverse('request-example', request)}
+ ])