diff options
| author | Tom Christie | 2013-07-29 09:21:20 +0100 | 
|---|---|---|
| committer | Tom Christie | 2013-07-29 09:21:20 +0100 | 
| commit | 856dc855c952746f566a6a8de263afe951362dfb (patch) | |
| tree | 93111fe491fdb6e9e2433598ceb8a73aa0b53343 | |
| parent | 6a6b2c93185f43e010e72312b32063052e11e1d8 (diff) | |
| download | django-rest-framework-856dc855c952746f566a6a8de263afe951362dfb.tar.bz2 | |
Notes on customizing BrowsableAPIRenderer.  Refs #1001
| -rw-r--r-- | docs/api-guide/renderers.md | 8 | 
1 files changed, 8 insertions, 0 deletions
| diff --git a/docs/api-guide/renderers.md b/docs/api-guide/renderers.md index 869bdc16..b434efe9 100644 --- a/docs/api-guide/renderers.md +++ b/docs/api-guide/renderers.md @@ -217,6 +217,14 @@ Renders data into HTML for the Browsable API.  This renderer will determine whic  **.charset**: `utf-8` +#### Customizing BrowsableAPIRenderer + +By default the response content will be rendered with the highest priority renderer apart from `BrowseableAPIRenderer`.  If you need to customize this behavior, for example to use HTML as the default return format, but use JSON in the browsable API, you can do so by overriding the `get_default_renderer()` method.  For example: + +    class CustomBrowsableAPIRenderer(BrowsableAPIRenderer): +        def get_default_renderer(self, view): +            return JSONRenderer() +  ## MultiPartRenderer  This renderer is used for rendering HTML multipart form data.  **It is not suitable as a response renderer**, but is instead used for creating test requests, using REST framework's [test client and test request factory][testing]. | 
