Namespaces are one honking great idea - let's do more of those!
Configuration for REST framework is all namespaced inside a single Django setting, namedREST_FRAMEWORK.
For example your project'ssettings.py file might include something like this:
REST_FRAMEWORK = { 'DEFAULT_RENDERER_CLASSES': [ 'rest_framework.renderers.JSONRenderer', ], 'DEFAULT_PARSER_CLASSES': [ 'rest_framework.parsers.JSONParser', ]}If you need to access the values of REST framework's API settings in your project,you should use theapi_settings object. For example.
from rest_framework.settings import api_settingsprint(api_settings.DEFAULT_AUTHENTICATION_CLASSES)Theapi_settings object will check for any user-defined settings, and otherwise fall back to the default values. Any setting that uses string import paths to refer to a class will automatically import and return the referenced class, instead of the string literal.
The following settings control the basic API policies, and are applied to everyAPIView class-based view, or@api_view function based view.
A list or tuple of renderer classes, that determines the default set of renderers that may be used when returning aResponse object.
Default:
[ 'rest_framework.renderers.JSONRenderer', 'rest_framework.renderers.BrowsableAPIRenderer',]A list or tuple of parser classes, that determines the default set of parsers used when accessing therequest.data property.
Default:
[ 'rest_framework.parsers.JSONParser', 'rest_framework.parsers.FormParser', 'rest_framework.parsers.MultiPartParser']A list or tuple of authentication classes, that determines the default set of authenticators used when accessing therequest.user orrequest.auth properties.
Default:
[ 'rest_framework.authentication.SessionAuthentication', 'rest_framework.authentication.BasicAuthentication']A list or tuple of permission classes, that determines the default set of permissions checked at the start of a view. Permission must be granted by every class in the list.
Default:
[ 'rest_framework.permissions.AllowAny',]A list or tuple of throttle classes, that determines the default set of throttles checked at the start of a view.
Default:[]
A content negotiation class, that determines how a renderer is selected for the response, given an incoming request.
Default:'rest_framework.negotiation.DefaultContentNegotiation'
A view inspector class that will be used for schema generation.
Default:'rest_framework.schemas.openapi.AutoSchema'
The following settings control the behavior of the generic class-based views.
A list of filter backend classes that should be used for generic filtering.If set toNone then generic filtering is disabled.
The default class to use for queryset pagination. If set toNone, paginationis disabled by default. See the pagination documentation for further guidance onsetting andmodifying the pagination style.
Default:None
The default page size to use for pagination. If set toNone, pagination is disabled by default.
Default:None
The name of a query parameter, which can be used to specify the search term used bySearchFilter.
Default:search
The name of a query parameter, which can be used to specify the ordering of results returned byOrderingFilter.
Default:ordering
The value that should be used forrequest.version when no versioning information is present.
Default:None
If set, this value will restrict the set of versions that may be returned by the versioning scheme, and will raise an error if the provided version if not in this set.
Default:None
The string that should used for any versioning parameters, such as in the media type or URL query parameters.
Default:'version'
The default versioning scheme to use.
Default:None
The following settings control the behavior of unauthenticated requests.
The class that should be used to initializerequest.user for unauthenticated requests.(If removing authentication entirely, e.g. by removingdjango.contrib.auth fromINSTALLED_APPS, setUNAUTHENTICATED_USER toNone.)
Default:django.contrib.auth.models.AnonymousUser
The class that should be used to initializerequest.auth for unauthenticated requests.
Default:None
The following settings control the behavior of APIRequestFactory and APIClient
The default format that should be used when making test requests.
This should match up with the format of one of the renderer classes in theTEST_REQUEST_RENDERER_CLASSES setting.
Default:'multipart'
The renderer classes that are supported when building test requests.
The format of any of these renderer classes may be used when constructing a test request, for example:client.post('/users', {'username': 'jamie'}, format='json')
Default:
[ 'rest_framework.renderers.MultiPartRenderer', 'rest_framework.renderers.JSONRenderer']If set, this maps the'pk' identifier in the URL conf onto the actual fieldname when generating a schema path parameter. Typically this will be'id'.This gives a more suitable representation as "primary key" is an implementationdetail, whereas "identifier" is a more general concept.
Default:True
If set, this is used to map internal viewset method names onto external actionnames used in the schema generation. This allows us to generate names thatare more suitable for an external representation than those that are usedinternally in the codebase.
Default:{'retrieve': 'read', 'destroy': 'delete'}
The name of a URL parameter that may be used to override the default content negotiationAccept header behavior, by using aformat=… query parameter in the request URL.
For example:http://example.com/organizations/?format=csv
If the value of this setting isNone then URL format overrides will be disabled.
Default:'format'
The name of a parameter in the URL conf that may be used to provide a format suffix. This setting is applied when usingformat_suffix_patterns to include suffixed URL patterns.
For example:http://example.com/organizations.csv/
Default:'format'
The following settings are used to control how date and time representations may be parsed and rendered.
A format string that should be used by default for rendering the output ofDateTimeField serializer fields. IfNone, thenDateTimeField serializer fields will return Pythondatetime objects, and the datetime encoding will be determined by the renderer.
May be any ofNone,'iso-8601' or a Pythonstrftime format string.
Default:'iso-8601'
A list of format strings that should be used by default for parsing inputs toDateTimeField serializer fields.
May be a list including the string'iso-8601' or Pythonstrftime format strings.
Default:['iso-8601']
A format string that should be used by default for rendering the output ofDateField serializer fields. IfNone, thenDateField serializer fields will return Pythondate objects, and the date encoding will be determined by the renderer.
May be any ofNone,'iso-8601' or a Pythonstrftime format string.
Default:'iso-8601'
A list of format strings that should be used by default for parsing inputs toDateField serializer fields.
May be a list including the string'iso-8601' or Pythonstrftime format strings.
Default:['iso-8601']
A format string that should be used by default for rendering the output ofTimeField serializer fields. IfNone, thenTimeField serializer fields will return Pythontime objects, and the time encoding will be determined by the renderer.
May be any ofNone,'iso-8601' or a Pythonstrftime format string.
Default:'iso-8601'
A list of format strings that should be used by default for parsing inputs toTimeField serializer fields.
May be a list including the string'iso-8601' or Pythonstrftime format strings.
Default:['iso-8601']
Indicates the default format that should be used for rendering the output ofDurationField serializer fields. IfNone, thenDurationField serializer fields will return Pythontimedelta objects, and the duration encoding will be determined by the renderer.
May be any ofNone,'iso-8601' or'django' (the format accepted bydjango.utils.dateparse.parse_duration).
Default:'django'
When set toTrue, JSON responses will allow unicode characters in responses. For example:
{"unicode black star":"★"}When set toFalse, JSON responses will escape non-ascii characters, like so:
{"unicode black star":"\u2605"}Both styles conform toRFC 4627, and are syntactically valid JSON. The unicode style is preferred as being more user-friendly when inspecting API responses.
Default:True
When set toTrue, JSON responses will return compact representations, with no spacing after':' and',' characters. For example:
{"is_admin":false,"email":"jane@example"}When set toFalse, JSON responses will return slightly more verbose representations, like so:
{"is_admin": false, "email": "jane@example"}The default style is to return minified responses, in line withHeroku's API design guidelines.
Default:True
When set toTrue, JSON rendering and parsing will only observe syntactically valid JSON, raising an exception for the extended float values (nan,inf,-inf) accepted by Python'sjson module. This is the recommended setting, as these values are not generally supported. e.g., neither Javascript'sJSON.Parse nor PostgreSQL's JSON data type accept these values.
When set toFalse, JSON rendering and parsing will be permissive. However, these values are still invalid and will need to be specially handled in your code.
Default:True
When returning decimal objects in API representations that do not support a native decimal type, it is normally best to return the value as a string. This avoids the loss of precision that occurs with binary floating point implementations.
When set toTrue, the serializerDecimalField class will return strings instead ofDecimal objects. When set toFalse, serializers will returnDecimal objects, which the default JSON encoder will return as floats.
Default:True
When returning biginteger objects in API representations that do not support numbers up to 2^64, it is best to return the value as a string. This avoids the loss of precision that occurs with biginteger implementations.
When set toTrue, the serializerBigIntegerField class (by default) will return strings instead ofBigInteger objects. When set toFalse, serializers will returnBigInteger objects, which the default JSON encoder will return as numbers.
Default:False
The following settings are used to generate the view names and descriptions, as used in responses toOPTIONS requests, and as used in the browsable API.
A string representing the function that should be used when generating view names.
This should be a function with the following signature:
view_name(self)self: The view instance. Typically the name function would inspect the name of the class when generating a descriptive name, by accessingself.__class__.__name__.If the view instance inheritsViewSet, it may have been initialized with several optional arguments:
name: A name explicitly provided to a view in the viewset. Typically, this value should be used as-is when provided.suffix: Text used when differentiating individual views in a viewset. This argument is mutually exclusive toname.detail: Boolean that differentiates an individual view in a viewset as either being a 'list' or 'detail' view.Default:'rest_framework.views.get_view_name'
A string representing the function that should be used when generating view descriptions.
This setting can be changed to support markup styles other than the default markdown. For example, you can use it to supportrst markup in your view docstrings being output in the browsable API.
This should be a function with the following signature:
view_description(self, html=False)self: The view instance. Typically the description function would inspect the docstring of the class when generating a description, by accessingself.__class__.__doc__html: A boolean indicating if HTML output is required.True when used in the browsable API, andFalse when used in generatingOPTIONS responses.If the view instance inheritsViewSet, it may have been initialized with several optional arguments:
description: A description explicitly provided to the view in the viewset. Typically, this is set by extra viewsetactions, and should be used as-is.Default:'rest_framework.views.get_view_description'
Global settings forselect field cutoffs for rendering relational fields in the browsable API.
Global setting for thehtml_cutoff value. Must be an integer.
Default: 1000
A string representing a global setting forhtml_cutoff_text.
Default:"More than {count} items..."
A string representing the function that should be used when returning a response for any given exception. If the function returnsNone, a 500 error will be raised.
This setting can be changed to support error responses other than the default{"detail": "Failure..."} responses. For example, you can use it to provide API responses like{"errors": [{"message": "Failure...", "code": ""} ...]}.
This should be a function with the following signature:
exception_handler(exc, context)exc: The exception.Default:'rest_framework.views.exception_handler'
A string representing the key that should be used for serializer errors that do not refer to a specific field, but are instead general errors.
Default:'non_field_errors'
A string representing the key that should be used for the URL fields generated byHyperlinkedModelSerializer.
Default:'url'
An integer of 0 or more, that may be used to specify the number of application proxies that the API runs behind. This allows throttling to more accurately identify client IP addresses. If set toNone then less strict IP matching will be used by the throttle classes.
Default:None