Skip to content

Commit 856dc85

Browse files
committed
Notes on customizing BrowsableAPIRenderer. Refs #1001
1 parent 6a6b2c9 commit 856dc85

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/api-guide/renderers.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,14 @@ Renders data into HTML for the Browsable API. This renderer will determine whic
217217

218218
**.charset**: `utf-8`
219219

220+
#### Customizing BrowsableAPIRenderer
221+
222+
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:
223+
224+
class CustomBrowsableAPIRenderer(BrowsableAPIRenderer):
225+
def get_default_renderer(self, view):
226+
return JSONRenderer()
227+
220228
## MultiPartRenderer
221229

222230
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].

0 commit comments

Comments
 (0)