aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide/views.md
diff options
context:
space:
mode:
authorJamie Matthews2012-10-27 13:53:07 +0100
committerJamie Matthews2012-10-27 13:53:07 +0100
commit5180b725655e84712b103fbc280353d25048068b (patch)
tree65398cd1446968c6e6afdfb0c6338f72e1c4faba /docs/api-guide/views.md
parent44207a347ac765d900f15b65bdd24dbf8eb9ead2 (diff)
downloaddjango-rest-framework-5180b725655e84712b103fbc280353d25048068b.tar.bz2
Documentation for function-based view decorators
Diffstat (limited to 'docs/api-guide/views.md')
-rw-r--r--docs/api-guide/views.md43
1 files changed, 41 insertions, 2 deletions
diff --git a/docs/api-guide/views.md b/docs/api-guide/views.md
index e3fbadb2..c51860b5 100644
--- a/docs/api-guide/views.md
+++ b/docs/api-guide/views.md
@@ -118,9 +118,48 @@ You won't typically need to override this method.
>
> — [Nick Coghlan][cite2]
-REST framework also gives you to work with regular function based views...
+REST framework also allows you to work with regular function based views. It provides a set of simple decorators that wrap your function based views to ensure they receive an instance of `Request` (rather than the usual Django `HttpRequest`) and allows them to return a `Response` (instead of a Django `HttpResponse`), and allow you to configure how the request is processed.
+
+### api_view(http_method_names)
+
+The core of this functionality is the `api_view` decorator, which takes a list of HTTP methods that your view should respond to. For example, this is how you would write a very simple view that just manually returns some data:
+
+ from rest_framework.decorators import api_view
+
+ @api_view(['GET'])
+ def hello_world(request):
+ return Response({"message": "Hello, world!"})
+
+
+This view will use the default renderers, parsers, authentication classes etc specified in the [settings](settings).
+
+To override the default settings, REST framework provides a set of additional decorators which can be added to your views. These must come *after* (below) the `api_view` decorator. For example, to create a view that uses a [throttle](throttling) to ensure it can only be called once per day by a particular user, use the `throttle_classes` decorator, passing a list of throttle classes:
+
+ from rest_framework.decorators import api_view, throttle_classes
+ from rest_framework.throttling import UserRateThrottle
+
+ class OncePerDayUserThrottle(UserRateThrottle):
+ rate = '1/day'
+
+ @api_view(['GET'])
+ @throttle_classes([OncePerDayUserThrottle])
+ def view(request):
+ return Response({"message": "Hello for today! See you tomorrow!"})
+
+These decorators correspond to the attributes set on `APIView` subclasses, described above.
+
+### renderer_classes(renderer_classes)
+
+### parser_classes(parser_classes)
+
+### authentication_classes(authentication_classes)
+
+### throttle_classes(throttle_classes)
+
+### permission_classes(permission_classes)
-**[TODO]**
[cite]: http://reinout.vanrees.org/weblog/2011/08/24/class-based-views-usage.html
[cite2]: http://www.boredomandlaziness.org/2012/05/djangos-cbvs-are-not-mistake-but.html
+[settings]: api-guide/settings.md
+[throttling]: api-guide/throttling.md