diff options
Diffstat (limited to 'docs/examples/blogpost.rst')
| -rw-r--r-- | docs/examples/blogpost.rst | 22 |
1 files changed, 9 insertions, 13 deletions
diff --git a/docs/examples/blogpost.rst b/docs/examples/blogpost.rst index 9d762f52..36b9d982 100644 --- a/docs/examples/blogpost.rst +++ b/docs/examples/blogpost.rst @@ -8,26 +8,22 @@ Blog Posts API The models ---------- +In this example we're working from two related models: + ``models.py`` .. include:: ../../examples/blogpost/models.py :literal: -URL configuration ------------------ - -``urls.py`` - -.. include:: ../../examples/blogpost/urls.py - :literal: - Creating the resources ---------------------- -Once we have some existing models there's very little we need to do to create the corresponding resources. We simply create a base resource and an instance resource for each model we're working with. -django-rest-framework will provide the default operations on the resources all the usual input validation that Django's models can give us for free. +Once we have some existing models there's very little we need to do to create the API. +Firstly create a resource for each model that defines which fields we want to expose on the model. +Secondly we map a base view and an instance view for each resource. +The generic views :class:`.ListOrCreateModelView` and :class:`.InstanceModelView` provide default operations for listing, creating and updating our models via the API, and also automatically provide input validation using default ModelForms for each model. -#``views.py`` +``urls.py`` -#.. include:: ../../examples/blogpost/views.py -# :literal:
\ No newline at end of file +.. include:: ../../examples/blogpost/urls.py + :literal: |