Package: drf-nested-routers
This is a work in progress. It "works for me" atwww.apiregistro.com.br,
but I cannot warranty that it fully "works everywhere" yet. Join us on Gitter (below) if you need some help.drf-nested-routersThis package provides routers and fields to create nested resources in theDjango Rest FrameworkNested resources are needed for full REST URL structure, if one resource lives inside another.The following example is about Domains and DNS Nameservers.
There are many domains, and each domain has many nameservers. The "nameserver" resource does not
exist without a domain, so you need it "nested" inside the domain.Requirements & CompatibilityPython (3.8, 3.9, 3.10, 3.11)Django (3.2, 4.1, 4.2)Django REST Framework (3.14)It may work with lower versions, but since the release0.93.5is no more tested on CI for Python 3.6 or lower.And since0.92.1is no more tested on CI for Pythons 2.7 to 3.5, Django 1.11 to 2.1 or DRF 3.6 to 3.10.Before that, the release0.90.2was tested also with DRF 2.4.3 up to 3.7.InstallationYou can install this library using pip:pip install drf-nested-routersIt is not needed to add this library in your Django project'ssettings.pyfile, as it does not contain any app, signal or model.QuickstartThe desired URL signatures are:/domain/ <- Domains list
/domain/{pk}/ <- One domain, from {pk}
/domain/{domain_pk}/nameservers/ <- Nameservers of domain from {domain_pk}
/domain/{domain_pk}/nameservers/{pk} <- Specific nameserver from {pk}, of domain from {domain_pk}How to do it (example):# urls.pyfromrest_framework_nestedimportroutersfromviewsimportDomainViewSet,NameserverViewSet(...)router=routers.SimpleRouter()router.register(r'domains',DomainViewSet)domains_router=routers.NestedSimpleRouter(router,r'domains',lookup='domain')domains_router.register(r'nameservers',NameserverViewSet,basename='domain-nameservers')# 'basename' is optional. Needed only if the same viewset is registered more than once# Official DRF docs on this option: http://www.django-rest-framework.org/api-guide/routers/urlpatterns=[path(r'',include(router.urls)),path(r'',include(domains_router.urls)),]# views.py## For Django' ORM-based resources ##classNameserverViewSet(viewsets.ModelViewSet):defget_queryset(self):returnNameserver.objects.filter(domain=self.kwargs['domain_pk'])## OR: non-ORM resources ##classNameserverViewSet(viewsets.ViewSet):deflist(self,request,domain_pk=None):nameservers=self.queryset.filter(domain=domain_pk)(...)returnResponse([...])defretrieve(self,request,pk=None,domain_pk=None):nameservers=self.queryset.get(pk=pk,domain=domain_pk)(...)returnResponse(serializer.data)AdvancedHyperlinks for Nested resources(optional)If you need hyperlinks for nested relations, you need a custom serializer.There you will inform how to access theparentof the instance being serialized when
building thechildrenURL.In the following example, an instance of Nameserver on/domain/{domain_pk}/nameservers/{pk}is being informed that theparentDomain should be looked up using thedomain_pkkwarg
from the URL:# serializers.py# (needed only if you want hyperlinks for nested relations on API)fromrest_framework_nested.relationsimportNestedHyperlinkedRelatedFieldclassDomainSerializer(HyperlinkedModelSerializer):classMeta:model=Domainnameservers=HyperlinkedIdentityField(view_name='domain-nameservers-list',lookup_url_kwarg='domain_pk'# ^-- Nameserver queryset will .get(domain_pk=domain_pk)#     being this value from URL kwargs)## OR ##nameservers=NestedHyperlinkedRelatedField(many=True,read_only=True,# Or add a querysetview_name='domain-nameservers-detail',parent_lookup_kwargs={'domain_pk':'domain__pk'}# ^-- Nameserver queryset will .filter(domain__pk=domain_pk)#     being domain_pk (ONE underscore) value from URL kwargs)(optional)If you want a little bit more control over the fields displayed for the nested relations while looking at the parent, you need a custom serializer using NestedHyperlinkedModelSerializer.fromrest_framework.serializersimportHyperlinkedModelSerializerfromrest_framework_nested.serializersimportNestedHyperlinkedModelSerializerclassNameserverSerializers(HyperlinkedModelSerializer):classMeta:model=Nameserverfields=(...)classDomainNameserverSerializers(NestedHyperlinkedModelSerializer):parent_lookup_kwargs={'domain_pk':'domain__pk',}classMeta:model=Nameserverfields=('url',...)classDomainSerializer(HyperlinkedModelSerializer):classMeta:model=Domainfields=(...,'nameservers')nameservers=DomainNameserverSerializers(many=True,read_only=True)Infinite-depth NestingExample of nested router 3 levels deep.
You can use this same logic to nest routers as deep as you need.
This example ahead accomplishes the below URL patterns./clients/
/clients/{pk}/
/clients/{client_pk}/maildrops/
/clients/{client_pk}/maildrops/{pk}/
/clients/{client_pk}/maildrops/{maildrop_pk}/recipients/
/clients/{client_pk}/maildrops/{maildrop_pk}/recipients/{pk}/# urls.pyrouter=DefaultRouter()router.register(r'clients',ClientViewSet,basename='clients')## generates:# /clients/# /clients/{pk}/client_router=routers.NestedSimpleRouter(router,r'clients',lookup='client')client_router.register(r'maildrops',MailDropViewSet,basename='maildrops')## generates:# /clients/{client_pk}/maildrops/# /clients/{client_pk}/maildrops/{pk}/maildrops_router=routers.NestedSimpleRouter(client_router,r'maildrops',lookup='maildrop')maildrops_router.register(r'recipients',MailRecipientViewSet,basename='recipients')## generates:# /clients/{client_pk}/maildrops/{maildrop_pk}/recipients/# /clients/{client_pk}/maildrops/{maildrop_pk}/recipients/{pk}/urlpatterns=[path(r'',include(router.urls)),path(r'',include(client_router.urls)),path(r'',include(maildrops_router.urls)),]# views.pyclassClientViewSet(viewsets.ViewSet):serializer_class=ClientSerializerdeflist(self,request,):queryset=Client.objects.filter()serializer=ClientSerializer(queryset,many=True)returnResponse(serializer.data)defretrieve(self,request,pk=None):queryset=Client.objects.filter()client=get_object_or_404(queryset,pk=pk)serializer=ClientSerializer(client)returnResponse(serializer.data)classMailDropViewSet(viewsets.ViewSet):serializer_class=MailDropSerializerdeflist(self,request,client_pk=None):queryset=MailDrop.objects.filter(client=client_pk)serializer=MailDropSerializer(queryset,many=True)returnResponse(serializer.data)defretrieve(self,request,pk=None,client_pk=None):queryset=MailDrop.objects.filter(pk=pk,client=client_pk)maildrop=get_object_or_404(queryset,pk=pk)serializer=MailDropSerializer(maildrop)returnResponse(serializer.data)classMailRecipientViewSet(viewsets.ViewSet):serializer_class=MailRecipientSerializerdeflist(self,request,client_pk=None,maildrop_pk=None):queryset=MailRecipient.objects.filter(mail_drop__client=client_pk,mail_drop=maildrop_pk)serializer=MailRecipientSerializer(queryset,many=True)returnResponse(serializer.data)defretrieve(self,request,pk=None,client_pk=None,maildrop_pk=None):queryset=MailRecipient.objects.filter(pk=pk,mail_drop=maildrop_pk,mail_drop__client=client_pk)maildrop=get_object_or_404(queryset,pk=pk)serializer=MailRecipientSerializer(maildrop)returnResponse(serializer.data)# serializers.pyclassClientSerializer(HyperlinkedModelSerializer):classMeta:model=Clientfields=(...)classMailDropSerializer(NestedHyperlinkedModelSerializer):parent_lookup_kwargs={'client_pk':'client__pk',}classMeta:model=MailDropfields=(...)classMailRecipientSerializer(NestedHyperlinkedModelSerializer):parent_lookup_kwargs={'maildrop_pk':'mail_drop__pk','client_pk':'mail_drop__client__pk',}classMeta:model=MailRecipientfields=(...)TestingIn order to get started with testing, you will need to installtox.
Once installed, you can then run one environment locally, to speed up your development cycle:$ tox -e py39-django3.1-drf3.11Once you submit a pull request, your changes will be run against many environments with GitHub Actions named CI.LicenseThis package is licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License athttp://www.apache.org/licenses/LICENSE-2.0and can undestand more athttp://choosealicense.com/licenses/apache/on the
sidebar notes.Apache Licence v2.0 is a MIT-like licence. This means, in plain English:It's truly open sourceYou can use it as you wish, for money or notYou can sublicence it (change the licence!!)This way, you can even use it on your closed-source project
As long as:You cannot use the authors name, logos, etc, to endorse a projectYou keep the authors copyright notices where this code got used, even on your closed-source project
(come on, even Microsoft kept BSD notices on Windows about its TCP/IP stack :P)