django-rest-framework API reference
49 public APIs from django-rest-framework (encode/django-rest-framework) — 42 classes, 4 functions, 3 methods. Signatures extracted by static analysis of the actual source.
Repository: encode/django-rest-framework
| Kind | Count |
|---|---|
| Classes | 42 |
| Functions | 4 |
| Methods | 3 |
API list
class
rest_framework.authentication.RemoteUserAuthenticationREMOTE_USER authentication.
class
rest_framework.authentication.SessionAuthenticationUse Django's session framework for authentication.
class
rest_framework.authentication.TokenAuthenticationSimple token based authentication.
class
rest_framework.authtoken.admin.TokenChangeListMap to matching User id
class
rest_framework.authtoken.models.TokenThe default authorization token model.
method
rest_framework.authtoken.models.Token.save(*args, **kwargs)Save the token instance.
class
rest_framework.authtoken.models.TokenProxyProxy mapping pk to user pk for use in admin.
class
rest_framework.exceptions.APIExceptionBase class for REST framework exceptions.
class
rest_framework.exceptions.ErrorDetailA string-like object that can additionally have a code.
func
rest_framework.exceptions.bad_request(request, exception, *args, **kwargs)Generic 400 error handler.
func
rest_framework.exceptions.server_error(request, *args, **kwargs)Generic 500 error handler.
class
rest_framework.fields.BuiltinSignatureErrorBuilt-in function signatures are not inspectable.
class
rest_framework.fields.IPAddressFieldSupport both IPAddressField and GenericIPAddressField
class
rest_framework.fields.ReadOnlyFieldA read-only field that simply returns the field value.
class
rest_framework.generics.CreateAPIViewConcrete view for creating a model instance.
class
rest_framework.generics.DestroyAPIViewConcrete view for deleting a model instance.
class
rest_framework.generics.GenericAPIViewBase class for all other generic views.
method
rest_framework.generics.GenericAPIView.get_queryset()Get the list of items for this view.
class
rest_framework.generics.ListAPIViewConcrete view for listing a queryset.
class
rest_framework.generics.RetrieveAPIViewConcrete view for retrieving a model instance.
class
rest_framework.generics.UpdateAPIViewConcrete view for updating a model instance.
class
rest_framework.metadata.SimpleMetadataThis is the default metadata implementation.
class
rest_framework.mixins.CreateModelMixinCreate a model instance.
class
rest_framework.mixins.DestroyModelMixinDestroy a model instance.
class
rest_framework.mixins.ListModelMixinList a queryset.
class
rest_framework.mixins.RetrieveModelMixinRetrieve a model instance.
class
rest_framework.mixins.UpdateModelMixinUpdate a model instance.
class
rest_framework.pagination.LimitOffsetPaginationA limit/offset based style.
class
rest_framework.parsers.FileUploadParserParser for file upload data.
class
rest_framework.parsers.FormParserParser for form data.
class
rest_framework.parsers.JSONParserParses JSON-serialized data.
class
rest_framework.permissions.AllowAnyAllow any access.
class
rest_framework.permissions.IsAdminUserAllows access only to admin users.
class
rest_framework.permissions.IsAuthenticatedAllows access only to authenticated users.
class
rest_framework.renderers.BrowsableAPIRendererHTML renderer used to self-document the API.
class
rest_framework.renderers.HTMLFormRendererRenderers serializer data into an HTML form.
class
rest_framework.renderers.JSONRendererRenderer which serializes to JSON.
class
rest_framework.renderers.TemplateHTMLRendererAn HTML renderer for use with templates.
class
rest_framework.request.EmptyPlaceholder for unset attributes.
class
rest_framework.routers.APIRootViewThe default basic root view for DefaultRouter
class
rest_framework.schemas.inspectors.ViewInspectorDescriptor class on APIView.
method
rest_framework.schemas.inspectors.ViewInspector.view()View property.
class
rest_framework.test.URLPatternsTestCaseIsolate URL patterns on a per-TestCase basis.
class
rest_framework.throttling.BaseThrottleRate throttling of requests.
class
rest_framework.utils.field_mapping.ClassLookupDictTakes a dictionary with classes as keys.
class
rest_framework.utils.formatting.lazy_formatDelay formatting until it's actually needed.
func
rest_framework.utils.timezone.datetime_ambiguous(dt:datetime)Check whether a datetime is ambiguous.
func
rest_framework.utils.timezone.datetime_exists(dt)Check if a datetime exists.
class
rest_framework.viewsets.ViewSetMixinThis is the magic.
About this data
These signatures were extracted from the public source of encode/django-rest-framework
using Python's ast module. Argument names, default values,
type annotations and return types are taken verbatim from the code.
Implementation bodies are never stored. See
how it works for details.