diff --git a/api-guide/authentication.html b/api-guide/authentication.html index 7af0894d0..f3b5db6f7 100644 --- a/api-guide/authentication.html +++ b/api-guide/authentication.html @@ -84,6 +84,7 @@ diff --git a/api-guide/content-negotiation.html b/api-guide/content-negotiation.html index e130d5af9..dc2618cde 100644 --- a/api-guide/content-negotiation.html +++ b/api-guide/content-negotiation.html @@ -84,6 +84,7 @@ diff --git a/api-guide/exceptions.html b/api-guide/exceptions.html index 61ac0620a..36cc80ab7 100644 --- a/api-guide/exceptions.html +++ b/api-guide/exceptions.html @@ -84,6 +84,7 @@ diff --git a/api-guide/fields.html b/api-guide/fields.html index eafb75a49..71de1d618 100644 --- a/api-guide/fields.html +++ b/api-guide/fields.html @@ -84,6 +84,7 @@ diff --git a/api-guide/format-suffixes.html b/api-guide/format-suffixes.html index e599d57b2..01e457fd9 100644 --- a/api-guide/format-suffixes.html +++ b/api-guide/format-suffixes.html @@ -84,6 +84,7 @@ diff --git a/api-guide/generic-views.html b/api-guide/generic-views.html index f878f82e6..540288d4b 100644 --- a/api-guide/generic-views.html +++ b/api-guide/generic-views.html @@ -84,6 +84,7 @@ diff --git a/api-guide/pagination.html b/api-guide/pagination.html index 381112111..c0da36ba8 100644 --- a/api-guide/pagination.html +++ b/api-guide/pagination.html @@ -84,6 +84,7 @@ diff --git a/api-guide/parsers.html b/api-guide/parsers.html index 4ea04f30a..4d397c559 100644 --- a/api-guide/parsers.html +++ b/api-guide/parsers.html @@ -84,6 +84,7 @@ diff --git a/api-guide/permissions.html b/api-guide/permissions.html index 6f9ff1b67..ea25c244e 100644 --- a/api-guide/permissions.html +++ b/api-guide/permissions.html @@ -84,6 +84,7 @@ diff --git a/api-guide/renderers.html b/api-guide/renderers.html index 4923e8e60..08fd1c664 100644 --- a/api-guide/renderers.html +++ b/api-guide/renderers.html @@ -84,6 +84,7 @@ diff --git a/api-guide/requests.html b/api-guide/requests.html index dbcad15a1..b352d5aab 100644 --- a/api-guide/requests.html +++ b/api-guide/requests.html @@ -84,6 +84,7 @@ diff --git a/api-guide/responses.html b/api-guide/responses.html index e832dcfbe..dc68e5cf8 100644 --- a/api-guide/responses.html +++ b/api-guide/responses.html @@ -84,6 +84,7 @@ diff --git a/api-guide/reverse.html b/api-guide/reverse.html index f04c4ed00..05e85bb63 100644 --- a/api-guide/reverse.html +++ b/api-guide/reverse.html @@ -84,6 +84,7 @@ diff --git a/api-guide/serializers.html b/api-guide/serializers.html index f6d37f70d..cf7dda5f6 100644 --- a/api-guide/serializers.html +++ b/api-guide/serializers.html @@ -84,6 +84,7 @@ diff --git a/api-guide/settings.html b/api-guide/settings.html index 5b62538d7..65114fba6 100644 --- a/api-guide/settings.html +++ b/api-guide/settings.html @@ -84,6 +84,7 @@ diff --git a/api-guide/status-codes.html b/api-guide/status-codes.html index 03f586138..ef1b2799f 100644 --- a/api-guide/status-codes.html +++ b/api-guide/status-codes.html @@ -84,6 +84,7 @@ diff --git a/api-guide/throttling.html b/api-guide/throttling.html index 66fd9c64d..2cb782bbd 100644 --- a/api-guide/throttling.html +++ b/api-guide/throttling.html @@ -84,6 +84,7 @@ diff --git a/api-guide/views.html b/api-guide/views.html index 4330c0024..b192bd536 100644 --- a/api-guide/views.html +++ b/api-guide/views.html @@ -84,6 +84,7 @@ diff --git a/img/quickstart.png b/img/quickstart.png new file mode 100644 index 000000000..5006d60fe Binary files /dev/null and b/img/quickstart.png differ diff --git a/index.html b/index.html index a9ce91b59..6913de0f7 100644 --- a/index.html +++ b/index.html @@ -84,6 +84,7 @@ @@ -170,7 +172,7 @@ pip install -r optionals.txt url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')) ) -

Note that the base URL can be whatever you want, but you must include rest_framework.urls with the rest_framework namespace.

+

Note that the URL path can be whatever you want, but you must include rest_framework.urls with the rest_framework namespace.

Quickstart

Can't wait to get started? The quickstart guide is the fastest way to get up and running with REST framework.

Tutorial

@@ -225,6 +227,7 @@ pip install -r optionals.txt

Run the tests:

./rest_framework/runtests/runtests.py
+

For more information see the Contributing to REST framework section.

Support

For support please see the REST framework discussion group, or try the #restframework channel on irc.freenode.net.

Paid support is also available from DabApps, and can include work on REST framework core, or support with building your REST framework API. Please contact Tom Christie if you'd like to discuss commercial support options.

diff --git a/topics/browsable-api.html b/topics/browsable-api.html index d49219736..20bb378b3 100644 --- a/topics/browsable-api.html +++ b/topics/browsable-api.html @@ -84,6 +84,7 @@ diff --git a/topics/browserhacks.html b/topics/browserhacks.html index 53ef05f35..6ac74ae05 100644 --- a/topics/browserhacks.html +++ b/topics/browserhacks.html @@ -84,6 +84,7 @@ diff --git a/topics/changelog.html b/topics/changelog.html index caf2eeda6..e346fddca 100644 --- a/topics/changelog.html +++ b/topics/changelog.html @@ -84,6 +84,7 @@ diff --git a/topics/contributing.html b/topics/contributing.html index 24843b48f..8260698b7 100644 --- a/topics/contributing.html +++ b/topics/contributing.html @@ -84,6 +84,7 @@ diff --git a/topics/credits.html b/topics/credits.html index bb2e61bb9..c810cd15a 100644 --- a/topics/credits.html +++ b/topics/credits.html @@ -84,6 +84,7 @@ diff --git a/topics/csrf.html b/topics/csrf.html index bfde9ec2d..2200ffb13 100644 --- a/topics/csrf.html +++ b/topics/csrf.html @@ -84,6 +84,7 @@ diff --git a/topics/migration.html b/topics/migration.html index a099cff76..a6d52e49b 100644 --- a/topics/migration.html +++ b/topics/migration.html @@ -84,6 +84,7 @@ diff --git a/topics/rest-hypermedia-hateoas.html b/topics/rest-hypermedia-hateoas.html index f255d14c6..752bf7125 100644 --- a/topics/rest-hypermedia-hateoas.html +++ b/topics/rest-hypermedia-hateoas.html @@ -84,6 +84,7 @@ diff --git a/tutorial/1-serialization.html b/tutorial/1-serialization.html index d0d0bc2f9..6c26feefa 100644 --- a/tutorial/1-serialization.html +++ b/tutorial/1-serialization.html @@ -84,6 +84,7 @@ diff --git a/tutorial/2-requests-and-responses.html b/tutorial/2-requests-and-responses.html index a0e7711b5..16fa22992 100644 --- a/tutorial/2-requests-and-responses.html +++ b/tutorial/2-requests-and-responses.html @@ -84,6 +84,7 @@ diff --git a/tutorial/3-class-based-views.html b/tutorial/3-class-based-views.html index f462bc907..1d959f52d 100644 --- a/tutorial/3-class-based-views.html +++ b/tutorial/3-class-based-views.html @@ -84,6 +84,7 @@ diff --git a/tutorial/4-authentication-permissions-and-throttling.html b/tutorial/4-authentication-permissions-and-throttling.html index 846d14d8a..815e2aa21 100644 --- a/tutorial/4-authentication-permissions-and-throttling.html +++ b/tutorial/4-authentication-permissions-and-throttling.html @@ -84,6 +84,7 @@ diff --git a/tutorial/5-relationships-and-hyperlinked-apis.html b/tutorial/5-relationships-and-hyperlinked-apis.html index a99d0fff2..37c08c527 100644 --- a/tutorial/5-relationships-and-hyperlinked-apis.html +++ b/tutorial/5-relationships-and-hyperlinked-apis.html @@ -84,6 +84,7 @@ diff --git a/tutorial/6-resource-orientated-projects.html b/tutorial/6-resource-orientated-projects.html index f7f54f60e..4c3fd02e9 100644 --- a/tutorial/6-resource-orientated-projects.html +++ b/tutorial/6-resource-orientated-projects.html @@ -84,6 +84,7 @@ diff --git a/tutorial/quickstart.html b/tutorial/quickstart.html index 446bb55ee..781401105 100644 --- a/tutorial/quickstart.html +++ b/tutorial/quickstart.html @@ -84,6 +84,7 @@ @@ -115,6 +117,7 @@
  • Views
  • URLs
  • Settings
    • +
  • Testing our API
    • @@ -227,6 +230,34 @@ REST_FRAMEWORK = { }

    Okay, that's us done.

    +
    +

    Testing our API

    +

    We can now access our API, both from the command-line, using tools like curl...

    +
    bash: curl -H 'Accept: application/json; indent=4' -u admin:password http://127.0.0.1:8000/users/ 
+{
+    "count": 2, 
+    "next": null, 
+    "previous": null, 
+    "results": [
+        {
+            "email": "admin@example.com", 
+            "groups": [], 
+            "url": "http://127.0.0.1:8000/users/1/", 
+            "username": "admin"
+        }, 
+        {
+            "email": "tom@example.com", 
+            "groups": [], 
+            "url": "http://127.0.0.1:8000/users/2/", 
+            "username": "tom"
+        }
+    ]
+}
+
    +

    Or directly through the browser...

    +

    Quick start image

    +

    Great, that was easy!

    +

    If you want to get a more in depth understanding of how REST framework fits together head on over to the tutorial, or start browsing the API guide.