encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-06-08 15:43:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Minor doc tweaks

Browse Source
This commit is contained in:
tom christie tom@tomchristie.com 2011-02-19 15:50:40 +00:00
parent d8285c2d49
commit 38c6a37af7
1 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/index.rst
View File

@ -1,6 +1,6 @@
.. meta:: .. meta::
:description: A lightweight REST framework for Django. :description: A lightweight REST framework for Django.
:keywords: django, python, REST, RESTful :keywords: django, python, REST, RESTful, API, interface, framework
Django REST framework Django REST framework
@ -9,7 +9,7 @@ Django REST framework
Introduction Introduction
------------ ------------
Django REST framework aims to make it easy to build well-connected, self-describing Web APIs with a minimum of fuss. Django REST framework aims to make it easy to build well-connected, self-describing Web APIs.
Features: Features:
@ -19,7 +19,7 @@ Features:
* Pluggable :mod:`.emitters`, :mod:`parsers`, :mod:`validators` and :mod:`authenticators` - Easy to customise. * Pluggable :mod:`.emitters`, :mod:`parsers`, :mod:`validators` and :mod:`authenticators` - Easy to customise.
* Content type negotiation using HTTP Accept headers. * Content type negotiation using HTTP Accept headers.
* Optional support for forms as input validation. * Optional support for forms as input validation.
* Modular architecture - The MixIn classes can even be used without using the core :class:`.Resource` or :class:`.ModelResource` classes. * Modular architecture - MixIn classes can be used without requiring the :class:`.Resource` or :class:`.ModelResource` classes.
For more information please head on over to the `discussion group <http://groups.google.com/group/django-rest-framework>`_. For more information please head on over to the `discussion group <http://groups.google.com/group/django-rest-framework>`_.
@ -52,7 +52,9 @@ For more information take a look at the :ref:`setup` section.
Getting Started Getting Started
--------------- ---------------
Using Django REST framework can be as simple as adding a few lines to your urlconf:: Using Django REST framework can be as simple as adding a few lines to your urlconf and adding a `permalink <http://docs.djangoproject.com/en/dev/ref/models/instances/#get-absolute-url>`_ to your model.
`urls.py`::
from django.conf.urls.defaults import patterns, url from django.conf.urls.defaults import patterns, url
from djangorestframework import ModelResource, RootModelResource from djangorestframework import ModelResource, RootModelResource
@ -60,9 +62,19 @@ Using Django REST framework can be as simple as adding a few lines to your urlco
urlpatterns = patterns('', urlpatterns = patterns('',
url(r'^$', RootModelResource.as_view(model=MyModel)), url(r'^$', RootModelResource.as_view(model=MyModel)),
url(r'^(?P<pk>[^/]+)/$', ModelResource.as_view(model=MyModel)), url(r'^(?P<pk>[^/]+)/$', ModelResource.as_view(model=MyModel), name='my-model'),
) )
`models.py`::
class MyModel(models.Model):
# (Rest of model definition...)
@models.permalink
def get_absolute_url(self):
return ('my-model', (self.pk,))
Django REST framework comes with two "getting started" examples. Django REST framework comes with two "getting started" examples.
#. :ref:`resources` #. :ref:`resources`