From 7dcb851c7f1e4bc01105fc5856494c196827fe2e Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 15 Jun 2011 14:09:01 +0100 Subject: Allow related models to be fully serialized --- docs/howto/alternativeframeworks.rst | 37 ++++++++++++++++++++++++++++++++---- 1 file changed, 33 insertions(+), 4 deletions(-) (limited to 'docs/howto/alternativeframeworks.rst') diff --git a/docs/howto/alternativeframeworks.rst b/docs/howto/alternativeframeworks.rst index c6eba1dd..dc8d1ea6 100644 --- a/docs/howto/alternativeframeworks.rst +++ b/docs/howto/alternativeframeworks.rst @@ -1,6 +1,35 @@ -Alternative Frameworks -====================== +Alternative frameworks & Why Django REST framework +================================================== -#. `django-piston `_ is excellent, and has a great community behind it. This project is based on piston code in parts. +Alternative frameworks +---------------------- -#. `django-tasypie `_ is also well worth looking at. +There are a number of alternative REST frameworks for Django: + +* `django-piston `_ is very mature, and has a large community behind it. This project was originally based on piston code in parts. +* `django-tasypie `_ is also very good, and has a very active and helpful developer community and maintainers. +* Other interesting projects include `dagny `_ and `dj-webmachine `_ + + +Why use Django REST framework? +------------------------------ + +The big benefits of using Django REST framework come down to: + +1. It's based on Django's class based views, which makes it simple, modular, and future-proof. +2. It stays as close as possible to Django idioms and language throughout. +3. The browse-able API makes working with the APIs extremely quick and easy. + + +Why was this project created? +----------------------------- + +For me the browse-able API is the most important aspect of Django REST framework. + +I wanted to show that Web APIs could easily be made Web browse-able, +and demonstrate how much better browse-able Web APIs are to work with. + +Being able to navigate and use a Web API directly in the browser is a huge win over only having command line and programmatic +access to the API. It enables the API to be properly self-describing, and it makes it much much quicker and easier to work with. +There's no fundamental reason why the Web APIs we're creating shouldn't be able to render to HTML as well as JSON/XML/whatever, +and I really think that more Web API frameworks *in whatever language* ought to be taking a similar approach. -- cgit v1.2.3