diff options
Diffstat (limited to 'docs/examples/modelviews.rst')
| -rw-r--r-- | docs/examples/modelviews.rst | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/examples/modelviews.rst b/docs/examples/modelviews.rst new file mode 100644 index 00000000..7cc78d39 --- /dev/null +++ b/docs/examples/modelviews.rst @@ -0,0 +1,51 @@ +.. _modelviews: + +Getting Started - Model Views +----------------------------- + +.. note:: + + A live sandbox instance of this API is available: + + http://api.django-rest-framework.org/model-resource-example/ + + You can browse the API using a web browser, or from the command line:: + + curl -X GET http://api.django-rest-framework.org/resource-example/ -H 'Accept: text/plain' + +Often you'll want parts of your API to directly map to existing django models. Django REST framework handles this nicely for you in a couple of ways: + +#. It automatically provides suitable create/read/update/delete methods for your views. +#. Input validation occurs automatically, by using appropriate `ModelForms <http://docs.djangoproject.com/en/dev/topics/forms/modelforms/>`_. + +Here's the model we're working from in this example: + +``models.py`` + +.. include:: ../../examples/modelresourceexample/models.py + :literal: + +To add an API for the model, all we need to do is create a Resource for the model, and map a couple of views to it in our urlconf. + +``urls.py`` + +.. include:: ../../examples/modelresourceexample/urls.py + :literal: + +And we're done. We've now got a fully browseable API, which supports multiple input and output media types, and has all the nice automatic field validation that Django gives us for free. + +We can visit the API in our browser: + +* http://api.django-rest-framework.org/model-resource-example/ + +Or access it from the command line using curl: + +.. code-block:: bash + + # Demonstrates API's input validation using form input + bash: curl -X POST --data 'foo=true' http://api.django-rest-framework.org/model-resource-example/ + {"detail": {"bar": ["This field is required."], "baz": ["This field is required."]}} + + # Demonstrates API's input validation using JSON input + bash: curl -X POST -H 'Content-Type: application/json' --data-binary '{"foo":true}' http://api.django-rest-framework.org/model-resource-example/ + {"detail": {"bar": ["This field is required."], "baz": ["This field is required."]}} |
