diff options
| author | Tom Christie | 2012-09-14 12:52:12 +0100 |
|---|---|---|
| committer | Tom Christie | 2012-09-14 12:52:12 +0100 |
| commit | f204439fa846d11c79870fb9a80323ee8684717d (patch) | |
| tree | e06fc4b20c94dea091c1b0ccfea55f32faf91df0 /docs/tutorial | |
| parent | eb761be9d058dbfb9214f200b941496524dc0ded (diff) | |
| parent | 4cbc53a75d2d30d05f202777d4e1626011c2cb2e (diff) | |
| download | django-rest-framework-f204439fa846d11c79870fb9a80323ee8684717d.tar.bz2 | |
Merge branch 'browsable-bootstrap' of https://github.com/droptype/django-rest-framework into droptype-browsable-bootstrap
Diffstat (limited to 'docs/tutorial')
| -rw-r--r-- | docs/tutorial/2-requests-and-responses.md | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/tutorial/2-requests-and-responses.md b/docs/tutorial/2-requests-and-responses.md index 89f92c4b..2c11d5ef 100644 --- a/docs/tutorial/2-requests-and-responses.md +++ b/docs/tutorial/2-requests-and-responses.md @@ -133,7 +133,12 @@ Now go and open the API in a web browser, by visiting [http://127.0.0.1:8000/][3 **Note: Right now the Browseable API only works with the CBV's. Need to fix that.** -**TODO: Describe browseable API awesomeness** +### Browsability + +Because the API chooses a return format based on what the client asks for, it will, by default, return an HTML-formatted representation of the resource when that resource is requested by a browser. This allows for the API to be easily browsable and usable by humans. + +See the [browsable api][4] topic for more information about the browsable API feature and how to customize it. + ## What's next? @@ -142,4 +147,5 @@ In [tutorial part 3][4], we'll start using class based views, and see how generi [json-url]: http://example.com/api/items/4.json [2]: 1-serialization.md [3]: http://127.0.0.1:8000/ -[4]: 3-class-based-views.md
\ No newline at end of file +[4]: ../topics/browsable-api.md +[5]: 3-class-based-views.md
\ No newline at end of file |