rest_framework.renderers.BrowsableAPIRenderer

class documentation

class BrowsableAPIRenderer(BaseRenderer): (source)

Known subclasses: rest_framework.renderers.AdminRenderer

HTML renderer used to self-document the API.

Method	`get_breadcrumbs`	Undocumented
Method	`get_content`	Get the content as if it had been rendered by the default non-documenting renderer.
Method	`get_context`	Returns the context used to render.
Method	`get_default_renderer`	Return an instance of the first valid renderer. (Don't use another documenting renderer.)
Method	`get_description`	Undocumented
Method	`get_extra_actions`	Undocumented
Method	`get_filter_form`	Undocumented
Method	`get_name`	Undocumented
Method	`get_raw_data_form`	Returns a form that allows for arbitrary content types to be tunneled via standard HTML forms. (Which are typically application/x-www-form-urlencoded)
Method	`get_rendered_html_form`	Return a string representing a rendered HTML form, possibly bound to either the input or output data.
Method	`render`	Render the HTML for the browsable API representation.
Method	`render_form_for_serializer`	Undocumented
Method	`show_form_for_method`	Returns True if a form should be shown for this method.
Class Variable	`charset`	Undocumented
Class Variable	`code_style`	Undocumented
Class Variable	`filter_template`	Undocumented
Class Variable	`format`	Undocumented
Class Variable	`media_type`	Undocumented
Class Variable	`template`	Undocumented
Instance Variable	`accepted_media_type`	Undocumented
Instance Variable	`renderer_context`	Undocumented
Method	`_get_serializer`	Undocumented

Inherited from BaseRenderer:

Class Variable render_style Undocumented

def get_breadcrumbs(self, request): (source) ¶

Undocumented

def get_content(self, renderer, data, accepted_media_type, renderer_context): (source) ¶

Get the content as if it had been rendered by the default non-documenting renderer.

def get_context(self, data, accepted_media_type, renderer_context): (source) ¶

overridden in rest_framework.renderers.AdminRenderer

Returns the context used to render.

def get_default_renderer(self, view): (source) ¶

Return an instance of the first valid renderer. (Don't use another documenting renderer.)

def get_description(self, view, status_code): (source) ¶

Undocumented

def get_extra_actions(self, view, status_code): (source) ¶

Undocumented

def get_filter_form(self, data, view, request): (source) ¶

Undocumented

def get_name(self, view): (source) ¶

Undocumented

def get_raw_data_form(self, data, view, method, request): (source) ¶

Returns a form that allows for arbitrary content types to be tunneled via standard HTML forms. (Which are typically application/x-www-form-urlencoded)

def get_rendered_html_form(self, data, view, method, request): (source) ¶

Return a string representing a rendered HTML form, possibly bound to either the input or output data. In the absence of the View having an associated form then return None.

def render(self, data, accepted_media_type=None, renderer_context=None): (source) ¶

overrides rest_framework.renderers.BaseRenderer.render

overridden in rest_framework.renderers.AdminRenderer

Render the HTML for the browsable API representation.

def render_form_for_serializer(self, serializer): (source) ¶

Undocumented

def show_form_for_method(self, view, method, request, obj): (source) ¶

Returns True if a form should be shown for this method.

charset: str = (source) ¶

overrides rest_framework.renderers.BaseRenderer.charset

Undocumented

code_style: str = (source) ¶