Working with the Browsable API
+The Browsable API
API may stand for Application Programming Interface, but humans have to be able to read the APIs, too; someone has to do the programming. Django REST Framework supports generating human-friendly HTML output for each resource when the HTML format is requested. These pages allow for easy browsing of resources, as well as forms for submitting data to the resources using POST, PUT, and DELETE.
URLs
If you include fully-qualified URLs in your resource output, they will be 'urlized' and made clickable for easy browsing by humans. The rest_framework package includes a reverse helper for this purpose.
- Working with AJAX and CSRF
- Browser enhancements -
- Working with the Browsable API +
- The Browsable API
- REST, Hypermedia & HATEOAS
- Contributing to REST framework
- 2.0 Migration Guide diff --git a/topics/changelog.html b/topics/changelog.html index edc1182b3..13140c53d 100644 --- a/topics/changelog.html +++ b/topics/changelog.html @@ -74,7 +74,7 @@
- Working with AJAX and CSRF
- Browser enhancements -
- Working with the Browsable API +
- The Browsable API
- REST, Hypermedia & HATEOAS
- Contributing to REST framework
- 2.0 Migration Guide diff --git a/topics/contributing.html b/topics/contributing.html index 88c99fd1c..c93c7aa46 100644 --- a/topics/contributing.html +++ b/topics/contributing.html @@ -74,7 +74,7 @@
- Working with AJAX and CSRF
- Browser enhancements -
- Working with the Browsable API +
- The Browsable API
- REST, Hypermedia & HATEOAS
- Contributing to REST framework
- 2.0 Migration Guide diff --git a/topics/credits.html b/topics/credits.html index 4ecb0d9ca..1c4b44b8f 100644 --- a/topics/credits.html +++ b/topics/credits.html @@ -74,7 +74,7 @@
- Working with AJAX and CSRF
- Browser enhancements -
- Working with the Browsable API +
- The Browsable API
- REST, Hypermedia & HATEOAS
- Contributing to REST framework
- 2.0 Migration Guide diff --git a/topics/csrf.html b/topics/csrf.html index 9b2c62f53..ff9f7fb38 100644 --- a/topics/csrf.html +++ b/topics/csrf.html @@ -74,7 +74,7 @@
- Working with AJAX and CSRF
- Browser enhancements -
- Working with the Browsable API +
- The Browsable API
- REST, Hypermedia & HATEOAS
- Contributing to REST framework
- 2.0 Migration Guide diff --git a/topics/migration.html b/topics/migration.html index c2970ae01..c6e024fad 100644 --- a/topics/migration.html +++ b/topics/migration.html @@ -74,7 +74,7 @@
- Working with AJAX and CSRF
- Browser enhancements -
- Working with the Browsable API +
- The Browsable API
- REST, Hypermedia & HATEOAS
- Contributing to REST framework
- 2.0 Migration Guide @@ -121,6 +121,10 @@
- Responses inherit from
SimpleTemplateResponse, allowing rendering to be delegated to the response, not handled by the view. - Requests extend the regular
HttpRequest, allowing authentication and parsing to be delegated to the request, not handled by the view.
- - Working with AJAX and CSRF
- Browser enhancements -
- Working with the Browsable API +
- The Browsable API
- REST, Hypermedia & HATEOAS
- Contributing to REST framework
- 2.0 Migration Guide diff --git a/tutorial/1-serialization.html b/tutorial/1-serialization.html index efcc4824c..0b9633b46 100644 --- a/tutorial/1-serialization.html +++ b/tutorial/1-serialization.html @@ -74,7 +74,7 @@
- Working with AJAX and CSRF
- Browser enhancements -
- Working with the Browsable API +
- The Browsable API
- REST, Hypermedia & HATEOAS
- Contributing to REST framework
- 2.0 Migration Guide diff --git a/tutorial/2-requests-and-responses.html b/tutorial/2-requests-and-responses.html index 1a6234573..aaf0ce5b3 100644 --- a/tutorial/2-requests-and-responses.html +++ b/tutorial/2-requests-and-responses.html @@ -74,7 +74,7 @@
- Working with AJAX and CSRF
- Browser enhancements -
- Working with the Browsable API +
- The Browsable API
- REST, Hypermedia & HATEOAS
- Contributing to REST framework
- 2.0 Migration Guide diff --git a/tutorial/3-class-based-views.html b/tutorial/3-class-based-views.html index a0e454c31..ebb1c273c 100644 --- a/tutorial/3-class-based-views.html +++ b/tutorial/3-class-based-views.html @@ -74,7 +74,7 @@
- Working with AJAX and CSRF
- Browser enhancements -
- Working with the Browsable API +
- The Browsable API
- REST, Hypermedia & HATEOAS
- Contributing to REST framework
- 2.0 Migration Guide diff --git a/tutorial/4-authentication-permissions-and-throttling.html b/tutorial/4-authentication-permissions-and-throttling.html index f5d14fcd4..80af912f5 100644 --- a/tutorial/4-authentication-permissions-and-throttling.html +++ b/tutorial/4-authentication-permissions-and-throttling.html @@ -74,7 +74,7 @@
- Working with AJAX and CSRF
- Browser enhancements -
- Working with the Browsable API +
- The Browsable API
- REST, Hypermedia & HATEOAS
- Contributing to REST framework
- 2.0 Migration Guide diff --git a/tutorial/5-relationships-and-hyperlinked-apis.html b/tutorial/5-relationships-and-hyperlinked-apis.html index b13bfb24f..9f4b6279c 100644 --- a/tutorial/5-relationships-and-hyperlinked-apis.html +++ b/tutorial/5-relationships-and-hyperlinked-apis.html @@ -74,7 +74,7 @@
- Working with AJAX and CSRF
- Browser enhancements -
- Working with the Browsable API +
- The Browsable API
- REST, Hypermedia & HATEOAS
- Contributing to REST framework
- 2.0 Migration Guide diff --git a/tutorial/6-resource-orientated-projects.html b/tutorial/6-resource-orientated-projects.html index 60ecb2c0a..9763b70bf 100644 --- a/tutorial/6-resource-orientated-projects.html +++ b/tutorial/6-resource-orientated-projects.html @@ -74,7 +74,7 @@
- Working with AJAX and CSRF
- Browser enhancements -
- Working with the Browsable API +
- The Browsable API
- REST, Hypermedia & HATEOAS
- Contributing to REST framework
- 2.0 Migration Guide diff --git a/tutorial/quickstart.html b/tutorial/quickstart.html index 25ebc8ab1..39dc5b3bc 100644 --- a/tutorial/quickstart.html +++ b/tutorial/quickstart.html @@ -74,7 +74,7 @@
2.0 Migration Guide
++Move fast and break things
+— Mark Zuckerberg, the Hacker Way.
+
REST framework 2.0 introduces a radical redesign of the core components, and a large number of backwards breaking changes.
Serialization redesign.
REST framework's serialization and deserialization previously used a slightly odd combination of serializers for output, and Django Forms and Model Forms for input. The serialization core has been completely redesigned based on work that was originally intended for Django core.
@@ -134,7 +138,7 @@Renamed attribnutes & classes.
+Renamed attributes & classes.
Various attributes and classes have been renamed in order to fit in better with Django's conventions.
Example: Blog Posts API
Let's take a look at an example from the REST framework 0.4 documentation...
diff --git a/topics/rest-hypermedia-hateoas.html b/topics/rest-hypermedia-hateoas.html index 80deac1b8..e5665ba06 100644 --- a/topics/rest-hypermedia-hateoas.html +++ b/topics/rest-hypermedia-hateoas.html @@ -74,7 +74,7 @@