Main NavigationHome Documentation

Appearance

Sidebar Navigation

Get started

Introduction

Installation

Essentials

Requests

Responses

Views

Generic views

ViewSets

Routers

Parsers

Renderers

Serializers

Validators

Authentication

Caching

Throttling

Filtering

Pagination

Versioning

Content negotiation

Metadata

Schema

Format suffixes

Returning URLs

Exceptions

Status Codes

Testing

Settings

Advanced

ViewSets

Custom ViewSet base classes

Routers

Customizing dynamic routes

Parsers

Custom parser

Renderers

Custom renderer

Permissions

Custom permission

Throttles

Custom throttles

Filtering

Custom generic filtering

Pagination

Customize pagination styles

Versioning

Custom versioning schemes

API Reference

Requests

data

query_params

parsers

accepted_renderer

accepted_media_type

user

auth

authenticators

method

content_type

stream

Responses

data

status_code

content

template_name

accepted_renderer

accepted_media_type

renderer_context

Views

@api_view

APIView

renderer_classes

parser_classes

authentication_classes

throttle_classes

permission_classes

content_negotiation_class

get_renderers()

get_parsers()

get_authenticators()

get_throttles()

get_content_negotiator()

check_permissions()

check_throttles()

perform_content_negotiation()

initial()

handle_exception()

initialize_request()

finalize_response()

Generic views

CreateAPIView

ListAPIView

RetrieveAPIView

UpdateAPIView

DestroyAPIView

queryset

serializer_class

permission_classes

pagination_class

filter_backends

lookup_field

lookup_url_kwarg

get_queryset()

get_object()

get_serializer_class()

get_serializer_context()

get_serializer()

get_paginated_response()

paginate_queryset()

filter_queryset()

list()

create()

retrieve()

update()

destroy()

ViewSets

ViewSet

GenericViewSet

ModelViewSet

ReadOnlyModelViewSet

Routers

SimpleRouter

DefaultRouter

Parsers

JSONParser

FormParser

MultiPartParser

FileUploadParser

stream

media_type

parser_context

Renderers

JSONRenderer

TemplateHTMLRenderer

StaticHTMLRenderer

BrowsableAPIRenderer

HTMLFormRenderer

MultiPartRenderer

Serializers

Validators

UniqueValidator

UniqueTogetherValidator

UniqueForDateValidator

UniqueForMonthValidator

UniqueForYearValidator

Authentication

BasicAuthentication

TokenAuthentication

SessionAuthentication

RemoteUserAuthentication

Permissions

AllowAny

IsAuthenticated

IsAdminUser

IsAuthenticatedOrReadOnly

DjangoModelPermissions

DjangoModelPermissionsOrAnonReadOnly

DjangoObjectPermissions

Caching

Throttling

AnonRateThrottle

UserRateThrottle

ScopedRateThrottle

Filtering

SearchFilter

OrderingFilter

DjangoFilterBackend

Pagination

PageNumberPagination

LimitOffsetPagination

CursorPagination

Versioning

AcceptHeaderVersioning

URLPathVersioning

NamespaceVersioning

HostNameVersioning

QueryParameterVersioning

Returning URLs

reverse

reverse_lazy

Exceptions

APIException

ParseError

AuthenticationFailed

NotAuthenticated

PermissionDenied

NotFound

MethodNotAllowed

NotAcceptable

UnsupportedMediaType

Throttled

ValidationError

server_error

bad_request

Testing

APIRequestFactory

APIClient

RequestsClient

CoreAPIClient

APISimpleTestCase

APITransactionTestCase

APITestCase

APILiveServerTestCase

URLPatternsTestCase

Settings

DEFAULT_RENDERER_CLASSES

DEFAULT_PARSER_CLASSES

DEFAULT_AUTHENTICATION_CLASSES

DEFAULT_PERMISSION_CLASSES

DEFAULT_THROTTLE_CLASSES

DEFAULT_CONTENT_NEGOTIATION_CLASS

DEFAULT_SCHEMA_CLASS

DEFAULT_FILTER_BACKENDS

DEFAULT_PAGINATION_CLASS

PAGE_SIZE

SEARCH_PARAM

ORDERING_PARAM

DEFAULT_VERSION

ALLOWED_VERSIONS

VERSION_PARAM

UNAUTHENTICATED_USER

UNAUTHENTICATED_TOKEN

TEST_REQUEST_DEFAULT_FORMAT

TEST_REQUEST_RENDERER_CLASSES

SCHEMA_COERCE_PATH_PK

SCHEMA_COERCE_METHOD_NAMES

URL_FORMAT_OVERRIDE

FORMAT_SUFFIX_KWARG

DATETIME_FORMAT

DATETIME_INPUT_FORMATS

DATE_FORMAT

DATE_INPUT_FORMATS

TIME_FORMAT

TIME_INPUT_FORMATS

UNICODE_JSON

COMPACT_JSON

STRICT_JSON

COERCE_DECIMAL_TO_STRING

VIEW_NAME_FUNCTION

VIEW_DESCRIPTION_FUNCTION

HTML_SELECT_CUTOFF

HTML_SELECT_CUTOFF_TEXT

EXCEPTION_HANDLER

NON_FIELD_ERRORS_KEY

URL_FIELD_NAME

NUM_PROXIES

On this page

Table of Contents for current page

Returning URLs API reference

reverse
reverse_lazy

Previous pageQueryParameterVersioning

Next pagereverse

Returning URLs API reference ​

Returning URLs API reference