Django REST Framework JSON API
v4.2.1
Getting Started
Usage
API Reference
Contributing
Django REST Framework JSON API
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
A
AutoPrefetchMixin (class in rest_framework_json_api.views)
AutoSchema (class in rest_framework_json_api.schemas.openapi)
B
bind() (rest_framework_json_api.relations.SerializerMethodFieldBase method)
BrowsableAPIRenderer (class in rest_framework_json_api.renderers)
build_json_resource_obj() (rest_framework_json_api.renderers.JSONRenderer class method)
build_link() (rest_framework_json_api.pagination.JsonApiPageNumberPagination method)
C
Conflict
conflict() (rest_framework_json_api.relations.ResourceRelatedField method)
content_types (rest_framework_json_api.schemas.openapi.AutoSchema attribute)
D
default_detail (rest_framework_json_api.exceptions.Conflict attribute)
default_error_messages (rest_framework_json_api.relations.PolymorphicResourceRelatedField attribute)
(rest_framework_json_api.relations.ResourceRelatedField attribute)
(rest_framework_json_api.serializers.ResourceIdentifierObjectSerializer attribute)
delete() (rest_framework_json_api.views.RelationshipView method)
determine_metadata() (rest_framework_json_api.metadata.JSONAPIMetadata method)
DjangoFilterBackend (class in rest_framework_json_api.django_filters.backends)
E
exception_handler() (in module rest_framework_json_api.exceptions)
extract_attributes() (rest_framework_json_api.renderers.JSONRenderer class method)
extract_included() (rest_framework_json_api.renderers.JSONRenderer class method)
extract_meta() (rest_framework_json_api.renderers.JSONRenderer class method)
extract_relation_instance() (rest_framework_json_api.renderers.JSONRenderer class method)
extract_relationships() (rest_framework_json_api.renderers.JSONRenderer class method)
extract_root_meta() (rest_framework_json_api.renderers.JSONRenderer class method)
F
field_name_mapping (rest_framework_json_api.views.RelationshipView attribute)
filter_queryset() (rest_framework_json_api.filters.QueryParameterValidationFilter method)
filter_regex (rest_framework_json_api.django_filters.backends.DjangoFilterBackend attribute)
format (rest_framework_json_api.renderers.JSONRenderer attribute)
format_drf_errors() (in module rest_framework_json_api.utils)
format_error_object() (in module rest_framework_json_api.utils)
format_errors() (in module rest_framework_json_api.utils)
format_field_name() (in module rest_framework_json_api.utils)
format_field_names() (in module rest_framework_json_api.utils)
format_link_segment() (in module rest_framework_json_api.utils)
format_resource_type() (in module rest_framework_json_api.utils)
format_value() (in module rest_framework_json_api.utils)
G
get() (rest_framework_json_api.views.RelationshipView method)
get_attribute() (rest_framework_json_api.relations.SerializerMethodFieldBase method)
(rest_framework_json_api.relations.SkipDataMixin method)
get_choices() (rest_framework_json_api.relations.ResourceRelatedField method)
get_context() (rest_framework_json_api.renderers.BrowsableAPIRenderer method)
get_default_included_resources_from_serializer() (in module rest_framework_json_api.utils)
get_field_info() (rest_framework_json_api.metadata.JSONAPIMetadata method)
get_field_names() (rest_framework_json_api.serializers.ModelSerializer method)
get_fields() (rest_framework_json_api.serializers.PolymorphicModelSerializer method)
get_filterset() (rest_framework_json_api.django_filters.backends.DjangoFilterBackend method)
get_filterset_kwargs() (rest_framework_json_api.django_filters.backends.DjangoFilterBackend method)
get_first_link() (rest_framework_json_api.pagination.JsonApiLimitOffsetPagination method)
get_included_resources() (in module rest_framework_json_api.utils)
get_included_serializers() (in module rest_framework_json_api.utils)
get_includes_form() (rest_framework_json_api.renderers.BrowsableAPIRenderer method)
get_last_link() (rest_framework_json_api.pagination.JsonApiLimitOffsetPagination method)
get_links() (rest_framework_json_api.relations.HyperlinkedMixin method)
(rest_framework_json_api.views.RelationshipView method)
get_operation() (rest_framework_json_api.schemas.openapi.AutoSchema method)
get_operation_id() (rest_framework_json_api.schemas.openapi.AutoSchema method)
get_paginated_response() (rest_framework_json_api.pagination.JsonApiLimitOffsetPagination method)
(rest_framework_json_api.pagination.JsonApiPageNumberPagination method)
get_parent_serializer() (rest_framework_json_api.relations.ResourceRelatedField method)
get_polymorphic_model_for_serializer() (rest_framework_json_api.serializers.PolymorphicModelSerializer class method)
get_polymorphic_model_for_type() (rest_framework_json_api.serializers.PolymorphicModelSerializer class method)
get_polymorphic_serializer_for_instance() (rest_framework_json_api.serializers.PolymorphicModelSerializer class method)
get_polymorphic_serializer_for_type() (rest_framework_json_api.serializers.PolymorphicModelSerializer class method)
get_polymorphic_types() (rest_framework_json_api.serializers.PolymorphicModelSerializer class method)
get_prefetch_related() (rest_framework_json_api.views.PreloadIncludesMixin method)
get_queryset() (rest_framework_json_api.views.AutoPrefetchMixin method)
(rest_framework_json_api.views.PreloadIncludesMixin method)
get_related_field_name() (rest_framework_json_api.views.RelatedMixin method)
(rest_framework_json_api.views.RelationshipView method)
get_related_instance() (rest_framework_json_api.views.RelatedMixin method)
(rest_framework_json_api.views.RelationshipView method)
get_related_resource_type() (in module rest_framework_json_api.utils)
get_related_serializer() (rest_framework_json_api.views.RelatedMixin method)
get_related_serializer_class() (rest_framework_json_api.views.RelatedMixin method)
get_relation_instance() (in module rest_framework_json_api.utils)
get_request_body() (rest_framework_json_api.schemas.openapi.AutoSchema method)
get_resource_name() (in module rest_framework_json_api.utils)
(rest_framework_json_api.views.RelationshipView method)
get_resource_type_from_included_serializer() (rest_framework_json_api.relations.ResourceRelatedField method)
get_resource_type_from_instance() (in module rest_framework_json_api.utils)
get_resource_type_from_manager() (in module rest_framework_json_api.utils)
get_resource_type_from_model() (in module rest_framework_json_api.utils)
get_resource_type_from_queryset() (in module rest_framework_json_api.utils)
get_resource_type_from_serializer() (in module rest_framework_json_api.utils)
get_schema() (rest_framework_json_api.schemas.openapi.SchemaGenerator method)
get_schema_operation_parameters() (rest_framework_json_api.django_filters.backends.DjangoFilterBackend method)
get_select_related() (rest_framework_json_api.views.PreloadIncludesMixin method)
get_serializer_class() (rest_framework_json_api.views.RelationshipView method)
get_serializer_fields() (in module rest_framework_json_api.utils)
get_serializer_info() (rest_framework_json_api.metadata.JSONAPIMetadata method)
get_url() (rest_framework_json_api.relations.HyperlinkedMixin method)
(rest_framework_json_api.views.RelationshipView method)
H
http_method_names (rest_framework_json_api.views.ModelViewSet attribute)
(rest_framework_json_api.views.ReadOnlyModelViewSet attribute)
(rest_framework_json_api.views.RelationshipView attribute)
Hyperlink (class in rest_framework_json_api.utils)
HyperlinkedMixin (class in rest_framework_json_api.relations)
HyperlinkedModelSerializer (class in rest_framework_json_api.serializers)
HyperlinkedRelatedField (class in rest_framework_json_api.relations)
I
IncludedResourcesValidationMixin (class in rest_framework_json_api.serializers)
includes_template (rest_framework_json_api.renderers.BrowsableAPIRenderer attribute)
is_hyperlink (rest_framework_json_api.utils.Hyperlink attribute)
is_serializer() (rest_framework_json_api.relations.ResourceRelatedField method)
J
jsonapi_components (rest_framework_json_api.schemas.openapi.SchemaGenerator attribute)
JsonApiLimitOffsetPagination (class in rest_framework_json_api.pagination)
JSONAPIMetadata (class in rest_framework_json_api.metadata)
JsonApiPageNumberPagination (class in rest_framework_json_api.pagination)
JSONAPISettings (class in rest_framework_json_api.settings)
JSONParser (class in rest_framework_json_api.parsers)
JSONRenderer (class in rest_framework_json_api.renderers)
L
limit_query_param (rest_framework_json_api.pagination.JsonApiLimitOffsetPagination attribute)
M
many_cls (rest_framework_json_api.relations.SerializerMethodHyperlinkedRelatedField attribute)
(rest_framework_json_api.relations.SerializerMethodResourceRelatedField attribute)
many_init() (rest_framework_json_api.relations.HyperlinkedRelatedField class method)
(rest_framework_json_api.relations.SerializerMethodResourceRelatedField class method)
many_kwargs (rest_framework_json_api.relations.SerializerMethodResourceRelatedField attribute)
ManyRelatedFieldWithNoData (class in rest_framework_json_api.relations)
ManySerializerMethodHyperlinkedRelatedField (class in rest_framework_json_api.relations)
ManySerializerMethodResourceRelatedField (class in rest_framework_json_api.relations)
map_serializer() (rest_framework_json_api.schemas.openapi.AutoSchema method)
max_limit (rest_framework_json_api.pagination.JsonApiLimitOffsetPagination attribute)
max_page_size (rest_framework_json_api.pagination.JsonApiPageNumberPagination attribute)
media_type (rest_framework_json_api.parsers.JSONParser attribute)
(rest_framework_json_api.renderers.JSONRenderer attribute)
model_class (rest_framework_json_api.serializers.ResourceIdentifierObjectSerializer attribute)
ModelSerializer (class in rest_framework_json_api.serializers)
ModelViewSet (class in rest_framework_json_api.views)
module
rest_framework_json_api
rest_framework_json_api.django_filters
rest_framework_json_api.django_filters.backends
rest_framework_json_api.exceptions
rest_framework_json_api.filters
rest_framework_json_api.metadata
rest_framework_json_api.pagination
rest_framework_json_api.parsers
rest_framework_json_api.relations
rest_framework_json_api.renderers
rest_framework_json_api.schemas
rest_framework_json_api.schemas.openapi
rest_framework_json_api.serializers
rest_framework_json_api.settings
rest_framework_json_api.utils
rest_framework_json_api.views
O
offset_query_param (rest_framework_json_api.pagination.JsonApiLimitOffsetPagination attribute)
ordering_param (rest_framework_json_api.filters.OrderingFilter attribute)
OrderingFilter (class in rest_framework_json_api.filters)
P
page_query_param (rest_framework_json_api.pagination.JsonApiPageNumberPagination attribute)
page_size_query_param (rest_framework_json_api.pagination.JsonApiPageNumberPagination attribute)
parse() (rest_framework_json_api.parsers.JSONParser method)
parse_attributes() (rest_framework_json_api.parsers.JSONParser static method)
parse_metadata() (rest_framework_json_api.parsers.JSONParser static method)
parse_relationships() (rest_framework_json_api.parsers.JSONParser static method)
patch() (rest_framework_json_api.views.RelationshipView method)
PolymorphicModelSerializer (class in rest_framework_json_api.serializers)
PolymorphicResourceRelatedField (class in rest_framework_json_api.relations)
PolymorphicSerializerMetaclass (class in rest_framework_json_api.serializers)
post() (rest_framework_json_api.views.RelationshipView method)
PreloadIncludesMixin (class in rest_framework_json_api.views)
Q
query_regex (rest_framework_json_api.filters.QueryParameterValidationFilter attribute)
QueryParameterValidationFilter (class in rest_framework_json_api.filters)
R
ReadOnlyModelViewSet (class in rest_framework_json_api.views)
related_link_lookup_field (rest_framework_json_api.relations.HyperlinkedMixin attribute)
(rest_framework_json_api.relations.ResourceRelatedField attribute)
related_link_view_name (rest_framework_json_api.relations.HyperlinkedMixin attribute)
(rest_framework_json_api.relations.ResourceRelatedField attribute)
(rest_framework_json_api.views.RelationshipView attribute)
RelatedMixin (class in rest_framework_json_api.views)
relation_type_lookup (rest_framework_json_api.metadata.JSONAPIMetadata attribute)
RelationshipView (class in rest_framework_json_api.views)
reload_json_api_settings() (in module rest_framework_json_api.settings)
remove_invalid_fields() (rest_framework_json_api.filters.OrderingFilter method)
remove_relationships() (rest_framework_json_api.views.RelationshipView method)
render() (rest_framework_json_api.renderers.JSONRenderer method)
render_errors() (rest_framework_json_api.renderers.JSONRenderer method)
render_relationship_view() (rest_framework_json_api.renderers.JSONRenderer method)
rendered_with_json_api() (in module rest_framework_json_api.exceptions)
renderer_class (rest_framework_json_api.parsers.JSONParser attribute)
resource_name (rest_framework_json_api.views.RelationshipView property)
ResourceIdentifierObjectSerializer (class in rest_framework_json_api.serializers)
ResourceRelatedField (class in rest_framework_json_api.relations)
rest_framework_json_api
module
rest_framework_json_api.django_filters
module
rest_framework_json_api.django_filters.backends
module
rest_framework_json_api.exceptions
module
rest_framework_json_api.filters
module
rest_framework_json_api.metadata
module
rest_framework_json_api.pagination
module
rest_framework_json_api.parsers
module
rest_framework_json_api.relations
module
rest_framework_json_api.renderers
module
rest_framework_json_api.schemas
module
rest_framework_json_api.schemas.openapi
module
rest_framework_json_api.serializers
module
rest_framework_json_api.settings
module
rest_framework_json_api.utils
module
rest_framework_json_api.views
module
retrieve_related() (rest_framework_json_api.views.RelatedMixin method)
S
SchemaGenerator (class in rest_framework_json_api.schemas.openapi)
search_param (rest_framework_json_api.django_filters.backends.DjangoFilterBackend attribute)
self_link_view_name (rest_framework_json_api.relations.HyperlinkedMixin attribute)
(rest_framework_json_api.relations.ResourceRelatedField attribute)
(rest_framework_json_api.views.RelationshipView attribute)
Serializer (class in rest_framework_json_api.serializers)
serializer_class (rest_framework_json_api.views.RelationshipView attribute)
serializer_related_field (rest_framework_json_api.serializers.ModelSerializer attribute)
SerializerMetaclass (class in rest_framework_json_api.serializers)
SerializerMethodFieldBase (class in rest_framework_json_api.relations)
SerializerMethodHyperlinkedRelatedField (class in rest_framework_json_api.relations)
SerializerMethodResourceRelatedField (class in rest_framework_json_api.relations)
set_resource_name() (rest_framework_json_api.views.RelationshipView method)
SkipDataMixin (class in rest_framework_json_api.relations)
SparseFieldsetsMixin (class in rest_framework_json_api.serializers)
status_code (rest_framework_json_api.exceptions.Conflict attribute)
T
template (rest_framework_json_api.renderers.BrowsableAPIRenderer attribute)
to_internal_value() (rest_framework_json_api.relations.PolymorphicResourceRelatedField method)
(rest_framework_json_api.relations.ResourceRelatedField method)
(rest_framework_json_api.serializers.PolymorphicModelSerializer method)
(rest_framework_json_api.serializers.ResourceIdentifierObjectSerializer method)
to_representation() (rest_framework_json_api.relations.ManySerializerMethodResourceRelatedField method)
(rest_framework_json_api.relations.ResourceRelatedField method)
(rest_framework_json_api.relations.SkipDataMixin method)
(rest_framework_json_api.serializers.PolymorphicModelSerializer method)
(rest_framework_json_api.serializers.ResourceIdentifierObjectSerializer method)
type_lookup (rest_framework_json_api.metadata.JSONAPIMetadata attribute)
U
undo_format_field_name() (in module rest_framework_json_api.utils)
undo_format_field_names() (in module rest_framework_json_api.utils)
undo_format_link_segment() (in module rest_framework_json_api.utils)
use_pk_only_optimization() (rest_framework_json_api.relations.PolymorphicResourceRelatedField method)
(rest_framework_json_api.relations.ResourceRelatedField method)
V
validate_query_params() (rest_framework_json_api.filters.QueryParameterValidationFilter method)
Read the Docs
v: v4.2.1
Versions
latest
stable
v4.2.1
v4.2.0
v4.1.0
v4.0.0
v3.2.0
v3.1.0
v3.0.0
v2.8.0
v2.7.0
v2.6.0
v2.5.0
v2.4.0
v2.3.1
v2.3.0
v2.2.0
v2.1.1
v2.1.0
v2.0.1
Downloads
On Read the Docs
Project Home
Builds