aboutsummaryrefslogtreecommitdiffstats
path: root/docs/examples.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/examples.rst')
-rw-r--r--docs/examples.rst26
1 files changed, 20 insertions, 6 deletions
diff --git a/docs/examples.rst b/docs/examples.rst
index 911ebdf3..64088345 100644
--- a/docs/examples.rst
+++ b/docs/examples.rst
@@ -1,9 +1,23 @@
+Examples
+========
+
+There are a few real world web API examples included with Django REST framework.
+
+#. :doc:`examples/objectstore` - Using :class:`views.View` classes for APIs that do not map to models.
+#. :doc:`examples/pygments` - Using :class:`views.View` classes with forms for input validation.
+#. :doc:`examples/blogpost` - Using :class:`views.ModelView` classes for APIs that map directly to models.
+
+All the examples are freely available for testing in the sandbox:
+
+ http://rest.ep.io
+
+(The :doc:`examples/sandbox` resource is also documented.)
+
+Example Reference
+-----------------
+
.. toctree::
:maxdepth: 1
+ :glob:
- examples/views
- examples/modelviews
- examples/objectstore
- examples/pygments
- examples/blogpost
- examples/sandbox
+ examples/*