Enhancement: Allow relationships to not be included

Author: TayHobbs

example/tests/test_serializers.py

@@ -112,3 +112,24 @@ def test_model_serializer_with_implicit_fields(self, comment, client):
         expected_json = dump_json(expected)
 
         assert actual == expected_json
+
+    def test_model_serializer_with_implicit_relationships_respecting_settings(self, comment, client, settings):
+        settings.JSON_API_IMPLICIT_RELATIONSHIPS = False
+        expected = {
+            "data": {
+                "type": "comments",
+                "id": str(comment.pk),
+                "attributes": {
+                    "body": comment.body
+                }
+            }
+        }
+
+        response = client.get(reverse("comment-detail", kwargs={'pk': comment.pk}))
+
+        assert response.status_code == 200
+
+        actual = redump_json(response.content)
+        expected_json = dump_json(expected)
+
+        assert actual == expected_json

rest_framework_json_api/renderers.py

@@ -7,6 +7,7 @@
 import inflection
 from django.db.models import Manager, QuerySet
 from django.utils import six, encoding
+from django.conf import settings
 from rest_framework import relations
 from rest_framework import renderers
 from rest_framework.serializers import BaseSerializer, Serializer, ListSerializer
@@ -387,9 +388,10 @@ def build_json_resource_obj(fields, resource, resource_instance, resource_name):
             ('id', encoding.force_text(resource_instance.pk) if resource_instance else None),
             ('attributes', JSONRenderer.extract_attributes(fields, resource)),
         ]
-        relationships = JSONRenderer.extract_relationships(fields, resource, resource_instance)
-        if relationships:
-            resource_data.append(('relationships', relationships))
+        if getattr(settings, 'JSON_API_IMPLICIT_RELATIONSHIPS', True):
+            relationships = JSONRenderer.extract_relationships(fields, resource, resource_instance)
+            if relationships:
+                resource_data.append(('relationships', relationships))
         # Add 'self' link if field is present and valid
         if api_settings.URL_FIELD_NAME in resource and \
                 isinstance(fields[api_settings.URL_FIELD_NAME], relations.RelatedField):