Skip to content

Commit cb7f830

Browse files
Anton-Shutiksliverc
Anton-Shutik
authored and
sliverc
committed
Add HyperlinkedRelatedField and SerializerMethodHyperlinkedRelatedField fields (django-json-api#445)
1 parent e33df0a commit cb7f830

13 files changed

+592
-68
lines changed

‎AUTHORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
Adam Wróbel <https://adamwrobel.com>
22
Adam Ziolkowski <adam@adsized.com>
33
Alan Crosswell <alan@columbia.edu>
4+
Anton Shutik <shutikanton@gmail.com>
45
Christian Zosel <https://zosel.ch>
56
Greg Aker <greg@gregaker.net>
67
Jamie Bliss <astronouth7303@gmail.com>

‎CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
* Add testing configuration to `REST_FRAMEWORK` configuration as described in [DRF](http://www.django-rest-framework.org/api-guide/testing/#configuration)
44
* Add sorting configuration to `REST_FRAMEWORK` as defined in [json api spec](http://jsonapi.org/format/#fetching-sorting)
5+
* Add `HyperlinkedRelatedField` and `SerializerMethodHyperlinkedRelatedField`. See [usage docs](docs/usage.md#related-fields)
56

67

78
v2.5.0 - Released July 11, 2018

‎docs/usage.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,8 @@ When set to pluralize:
324324

325325
### Related fields
326326

327+
#### ResourceRelatedField
328+
327329
Because of the additional structure needed to represent relationships in JSON
328330
API, this package provides the `ResourceRelatedField` for serializers, which
329331
works similarly to `PrimaryKeyRelatedField`. By default,
@@ -435,6 +437,12 @@ class LineItemViewSet(viewsets.ModelViewSet):
435437
return queryset
436438
```
437439

440+
#### HyperlinkedRelatedField
441+
442+
`HyperlinkedRelatedField` has same functionality as `ResourceRelatedField` but does
443+
not render `data`. Use this in case you only need links of relationships and want to lower payload
444+
and increase performance.
445+
438446
### RelationshipView
439447
`rest_framework_json_api.views.RelationshipView` is used to build
440448
relationship views (see the

‎example/serializers.py

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,19 +67,58 @@ def __init__(self, *args, **kwargs):
6767
}
6868

6969
body_format = serializers.SerializerMethodField()
70+
# single related from model
71+
blog_hyperlinked = relations.HyperlinkedRelatedField(
72+
related_link_view_name='entry-blog',
73+
related_link_url_kwarg='entry_pk',
74+
self_link_view_name='entry-relationships',
75+
read_only=True,
76+
source='blog'
77+
)
7078
# many related from model
7179
comments = relations.ResourceRelatedField(
7280
many=True, read_only=True)
81+
# many related hyperlinked from model
82+
comments_hyperlinked = relations.HyperlinkedRelatedField(
83+
related_link_view_name='entry-comments',
84+
related_link_url_kwarg='entry_pk',
85+
self_link_view_name='entry-relationships',
86+
many=True,
87+
read_only=True,
88+
source='comments'
89+
)
7390
# many related from serializer
7491
suggested = relations.SerializerMethodResourceRelatedField(
75-
source='get_suggested', model=Entry, many=True, read_only=True,
7692
related_link_view_name='entry-suggested',
7793
related_link_url_kwarg='entry_pk',
7894
self_link_view_name='entry-relationships',
95+
source='get_suggested',
96+
model=Entry,
97+
many=True,
98+
read_only=True
99+
)
100+
# many related hyperlinked from serializer
101+
suggested_hyperlinked = relations.SerializerMethodHyperlinkedRelatedField(
102+
related_link_view_name='entry-suggested',
103+
related_link_url_kwarg='entry_pk',
104+
self_link_view_name='entry-relationships',
105+
source='get_suggested',
106+
model=Entry,
107+
many=True,
108+
read_only=True
79109
)
80110
# single related from serializer
81111
featured = relations.SerializerMethodResourceRelatedField(
82112
source='get_featured', model=Entry, read_only=True)
113+
# single related hyperlinked from serializer
114+
featured_hyperlinked = relations.SerializerMethodHyperlinkedRelatedField(
115+
related_link_view_name='entry-featured',
116+
related_link_url_kwarg='entry_pk',
117+
self_link_view_name='entry-relationships',
118+
source='get_featured',
119+
model=Entry,
120+
read_only=True
121+
)
83122
tags = TaggedItemSerializer(many=True, read_only=True)
84123

85124
def get_suggested(self, obj):
@@ -93,8 +132,9 @@ def get_body_format(self, obj):
93132

94133
class Meta:
95134
model = Entry
96-
fields = ('blog', 'headline', 'body_text', 'pub_date', 'mod_date',
97-
'authors', 'comments', 'featured', 'suggested', 'tags')
135+
fields = ('blog', 'blog_hyperlinked', 'headline', 'body_text', 'pub_date', 'mod_date',
136+
'authors', 'comments', 'comments_hyperlinked', 'featured', 'suggested',
137+
'suggested_hyperlinked', 'tags', 'featured_hyperlinked')
98138
read_only_fields = ('tags',)
99139
meta_fields = ('body_format',)
100140

‎example/tests/integration/test_non_paginated_responses.py

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@ def test_multiple_entries_no_pagination(multiple_entries, client):
3535
"blog": {
3636
"data": {"type": "blogs", "id": "1"}
3737
},
38+
"blogHyperlinked": {
39+
"links": {
40+
"related": "http://testserver/entries/1/blog",
41+
"self": "http://testserver/entries/1/relationships/blog_hyperlinked"
42+
}
43+
},
3844
"authors": {
3945
"meta": {"count": 1},
4046
"data": [{"type": "authors", "id": "1"}]
@@ -43,13 +49,32 @@ def test_multiple_entries_no_pagination(multiple_entries, client):
4349
"meta": {"count": 1},
4450
"data": [{"type": "comments", "id": "1"}]
4551
},
52+
"commentsHyperlinked": {
53+
"links": {
54+
"related": "http://testserver/entries/1/comments",
55+
"self": "http://testserver/entries/1/relationships/comments_hyperlinked"
56+
}
57+
},
4658
"suggested": {
4759
"data": [{"type": "entries", "id": "2"}],
4860
"links": {
4961
"related": "http://testserver/entries/1/suggested/",
5062
"self": "http://testserver/entries/1/relationships/suggested"
5163
}
5264
},
65+
"suggestedHyperlinked": {
66+
"links": {
67+
"related": "http://testserver/entries/1/suggested/",
68+
"self": "http://testserver/entries/1"
69+
"/relationships/suggested_hyperlinked"
70+
}
71+
},
72+
"featuredHyperlinked": {
73+
"links": {
74+
"related": "http://testserver/entries/1/featured",
75+
"self": "http://testserver/entries/1/relationships/featured_hyperlinked"
76+
}
77+
},
5378
"tags": {
5479
"data": []
5580
}
@@ -73,6 +98,12 @@ def test_multiple_entries_no_pagination(multiple_entries, client):
7398
"blog": {
7499
"data": {"type": "blogs", "id": "2"}
75100
},
101+
"blogHyperlinked": {
102+
"links": {
103+
"related": "http://testserver/entries/2/blog",
104+
"self": "http://testserver/entries/2/relationships/blog_hyperlinked",
105+
}
106+
},
76107
"authors": {
77108
"meta": {"count": 1},
78109
"data": [{"type": "authors", "id": "2"}]
@@ -81,13 +112,32 @@ def test_multiple_entries_no_pagination(multiple_entries, client):
81112
"meta": {"count": 1},
82113
"data": [{"type": "comments", "id": "2"}]
83114
},
115+
"commentsHyperlinked": {
116+
"links": {
117+
"related": "http://testserver/entries/2/comments",
118+
"self": "http://testserver/entries/2/relationships/comments_hyperlinked"
119+
}
120+
},
84121
"suggested": {
85122
"data": [{"type": "entries", "id": "1"}],
86123
"links": {
87124
"related": "http://testserver/entries/2/suggested/",
88125
"self": "http://testserver/entries/2/relationships/suggested"
89126
}
90127
},
128+
"suggestedHyperlinked": {
129+
"links": {
130+
"related": "http://testserver/entries/2/suggested/",
131+
"self": "http://testserver/entries/2"
132+
"/relationships/suggested_hyperlinked"
133+
}
134+
},
135+
"featuredHyperlinked": {
136+
"links": {
137+
"related": "http://testserver/entries/2/featured",
138+
"self": "http://testserver/entries/2/relationships/featured_hyperlinked"
139+
}
140+
},
91141
"tags": {
92142
"data": []
93143
}

‎example/tests/integration/test_pagination.py

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ def test_pagination_with_single_entry(single_entry, client):
3636
"blog": {
3737
"data": {"type": "blogs", "id": "1"}
3838
},
39+
"blogHyperlinked": {
40+
"links": {
41+
"related": "http://testserver/entries/1/blog",
42+
"self": "http://testserver/entries/1/relationships/blog_hyperlinked",
43+
}
44+
},
3945
"authors": {
4046
"meta": {"count": 1},
4147
"data": [{"type": "authors", "id": "1"}]
@@ -44,13 +50,32 @@ def test_pagination_with_single_entry(single_entry, client):
4450
"meta": {"count": 1},
4551
"data": [{"type": "comments", "id": "1"}]
4652
},
53+
"commentsHyperlinked": {
54+
"links": {
55+
"related": "http://testserver/entries/1/comments",
56+
"self": "http://testserver/entries/1/relationships/comments_hyperlinked"
57+
}
58+
},
4759
"suggested": {
4860
"data": [],
4961
"links": {
5062
"related": "http://testserver/entries/1/suggested/",
5163
"self": "http://testserver/entries/1/relationships/suggested"
5264
}
5365
},
66+
"suggestedHyperlinked": {
67+
"links": {
68+
"related": "http://testserver/entries/1/suggested/",
69+
"self": "http://testserver/entries/1"
70+
"/relationships/suggested_hyperlinked"
71+
}
72+
},
73+
"featuredHyperlinked": {
74+
"links": {
75+
"related": "http://testserver/entries/1/featured",
76+
"self": "http://testserver/entries/1/relationships/featured_hyperlinked"
77+
}
78+
},
5479
"tags": {
5580
"data": [
5681
{

0 commit comments

Comments
 (0)