rest_framework.views

module documentation

(source)

Provides an APIView class that is the base of all views in REST framework.

Class	`APIView`	No class docstring; 1/2 property, 0/7 instance variable, 0/1 class variable, 29/30 methods, 1/1 class method documented
Function	`exception_handler`	Returns the response that should be used for any given exception.
Function	`get_view_description`	Given a view instance, return a textual description to represent the view. This name is used in the browsable API, and in OPTIONS responses.
Function	`get_view_name`	Given a view instance, return a textual name to represent the view. This name is used in the browsable API, and in OPTIONS responses.
Function	`set_rollback`	Undocumented

def exception_handler(exc, context): (source) ¶

Returns the response that should be used for any given exception. By default we handle the REST framework `APIException`, and also Django's built-in `Http404` and `PermissionDenied` exceptions. Any unhandled exceptions may return `None`, which will cause a 500 error to be raised.

def get_view_description(view, html=False): (source) ¶

Given a view instance, return a textual description to represent the view. This name is used in the browsable API, and in OPTIONS responses. This function is the default for the `VIEW_DESCRIPTION_FUNCTION` setting.

def get_view_name(view): (source) ¶

Given a view instance, return a textual name to represent the view. This name is used in the browsable API, and in OPTIONS responses. This function is the default for the `VIEW_NAME_FUNCTION` setting.

def set_rollback(): (source) ¶

Undocumented