rest_framework
- ______ _____ _____ _____ __ | ___ \ ___/ ___|_ _| / _| | | | |_/ / |__ \ `--. | | | |_ _ __ __ _ _ __ ___ _____ _____ _ __| |__ | /| __| `--...apps
- Undocumentedauthentication
- Provides various authentication policies.authtoken
- Undocumentedadmin
- No module docstring; 0/1 variable, 1/2 class documentedapps
- Undocumentedmanagement
- Undocumentedcommands
- Undocumenteddrf_create_token
- Undocumentedmigrations
- Undocumented0001_initial
- Undocumented0002_auto_20160226_1747
- Undocumented0003_tokenproxy
- Undocumentedmodels
- No module docstring; 2/2 classes documentedserializers
- Undocumentedviews
- Undocumentedchecks
- Undocumentedcompat
- The `compat` module provides support for backwards compatibility with older versions of Django/Python, and compatibility wrappers around optional packages.decorators
- The most important decorator in this module is `@api_view`, which is used for writing function-based views with REST framework.documentation
- Undocumentedexceptions
- Handled exceptions raised by REST framework.fields
- No module docstring; 0/6 constant, 7/7 functions, 1/2 exception, 7/33 classes documentedfilters
- Provides generic filtering backends that can be used to filter the results returned by list views.generics
- Generic views that provide commonly needed behaviour.management
- Undocumentedcommands
- Undocumentedgenerateschema
- Undocumentedmetadata
- The metadata API is used to allow customization of how `OPTIONS` requests are handled. We currently provide a single default implementation that returns some fairly ad-hoc information about the view.mixins
- Basic building blocks for generic class based views.negotiation
- Content negotiation deals with selecting an appropriate renderer given the incoming request. Typically this will be based on the request's Accept header.pagination
- Pagination serializers determine the structure of the output that should be used for paginated responses.parsers
- Parsers are used to parse the content of incoming HTTP requests.permissions
- Provides a set of pluggable permission policies.relations
- No module docstring; 0/1 constant, 1/1 function, 2/2 exceptions, 6/9 classes documentedrenderers
- Renderers are used to serialize a response into specific media types.request
- The Request class is used as a wrapper around the standard request object.response
- The Response class in REST framework is similar to HTTPResponse, except that it is initialized with unrendered data, instead of a pre-rendered string.reverse
- Provide urlresolver functions that return fully qualified URLs or view namesrouters
- Routers provide a convenient and consistent way of automatically determining the URL conf for your API.schemas
- rest_framework.schemascoreapi
- No module docstring; 0/1 constant, 2/6 functions, 3/4 classes documentedgenerators
- generators.py # Top-down schema generationinspectors
- inspectors.py # Per-endpoint view introspectionopenapi
- Undocumentedutils
- utils.py # Shared helper functionsviews
- views.py # Houses `SchemaView`, `APIView` subclass.serializers
- Serializers and ModelSerializers are similar to Forms and ModelForms. Unlike forms, they are not constrained to dealing with HTML output, and form encoded input.settings
- Settings for REST framework are all namespaced in the REST_FRAMEWORK setting. For example your project's `settings.py` file might look like this:status
- Descriptive HTTP status codes, for code readability.templatetags
- Undocumentedrest_framework
- No module docstring; 0/6 variable, 0/2 constant, 10/21 functions, 0/1 class documentedtest
- No module docstring; 0/2 function, 3/13 classes documentedthrottling
- Provides various throttling policies.urlpatterns
- No module docstring; 1/3 function documentedurls
- Login and logout views for the browsable API.utils
- No package docstring; 9/12 modules documentedbreadcrumbs
- No module docstring; 1/1 function documentedencoders
- Helper classes for parsers.field_mapping
- Helper functions for mapping model fields to a dictionary of default keyword arguments that should be used for their equivalent serializer fields.formatting
- Utility functions to return a formatted name and description for a given view.html
- Helpers for dealing with HTML input.humanize_datetime
- Helper functions that convert strftime formats into more readable representations.json
- Wrapper for the builtin json module that ensures compliance with the JSON spec.mediatypes
- Handling of media types, as found in HTTP Content-Type and Accept headers.model_meta
- Helper function for returning the field information that is associated with a model class. This includes returning all the forward and reverse relationships and their associated metadata.representation
- Helper functions for creating user-friendly representations of serializer classes and serializer fields.serializer_helpers
- No module docstring; 5/6 classes documentedurls
- No module docstring; 2/2 functions documentedvalidators
- We perform uniqueness checks explicitly on the serializer class, rather the using Django's `.full_clean()`.versioning
- No module docstring; 5/6 classes documentedviews
- Provides an APIView class that is the base of all views in REST framework.viewsets
- ViewSets are essentially just a type of class based view, that doesn't provide any method handlers, such as `get()`, `post()`, etc... but instead has actions, such as `list()`, `retrieve()`, `create()`, etc...