Support for nested routes in the Django REST Framework
Project description
# drf-nested-resources
This is a django rest framework extension to allow developers to create nested
resources.
## How to use
### Configuration of nested resources
For this example we are going to create a simple API with the following
endpoints:
/developers/
/developers/<id>
/developers/<id>/languages/
/developers/<id>/languages/<id>
First we start with the following Django models:
```python
from django.db.models.base import Model
from django.db.models.fields import CharField
from django.db.models.fields.related import ForeignKey
class Developer(Model):
name = CharField(max_length=20)
class ProgrammingLanguage(Model):
name = CharField(max_length=20)
author = ForeignKey(Developer, related_name='programming_languages')
```
We will have the two viewsets for both the `developers` and `languages` resource
collections.
```python
from rest_framework.viewsets import ModelViewSet
from drf_nested_resources.fields import HyperlinkedNestedModelSerializer
class _DeveloperSerializer(HyperlinkedNestedModelSerializer):
class Meta(object):
model = Developer
fields = ('url', 'name', 'programming_languages')
class DeveloperViewSet(ModelViewSet):
queryset = Developer.objects.all()
serializer_class = _DeveloperSerializer
class _ProgrammingLanguageSerializer(HyperlinkedNestedModelSerializer):
class Meta(object):
model = ProgrammingLanguage
fields = ('url', 'name', 'author')
class ProgrammingLanguageViewSet(ModelViewSet):
queryset = ProgrammingLanguage.objects.all()
serializer_class = _ProgrammingLanguageSerializer
```
The related fields in the ViewSets `author` and `programming_languages` should
follow the model representation so that `author` will give us a url for the
developer who wrote the ProgrammingLanguage and the `programming_languages`
should give us a list of urls for the ProgrammingLanguages that the Developer
wrote.
This is how you would generate the urlpatterns for them:
```python
_RESOURCES = [
Resource(
'developer',
'developers',
DeveloperViewSet,
[
NestedResource(
'language',
'languages',
ProgrammingLanguageViewSet,
parent_field_lookup='author',
)
],
),
]
urlpatterns = make_urlpatterns_from_resources(_RESOURCES)
```
For more examples of different relationships and authorization check the test
suite.
Changelog
=========
Version 1.2 Beta 3
------------------
Fixed error when urlconf was not explicitly set on the request
Version 1.2 Beta 2
------------------
Fixed support for non-session-based authenticators when checking permissions in
viewsets in the ancestry.
Version 1.2 Beta 1
------------------
Implemented ability to force a field value in a nested resource to be set to
the URL of an ascending resource. This is done using the optional attribute
``field_forced_to_ancestor`` on the serializer's ``Meta`` class.
Version 1.1
-----------
Re-worked the mechanism for URL generation to support cross-linking resource
trees.
**Breaking change**: Any previous usage of many-to-many fields on variables
in the current request's URL will now break.
Version 1.0 Release Candidate 3
-------------------------------
Added proper support for namespaced URLs
Version 1.0 Release Candidate 1
-------------------------------
Added support for Django 1.10 and Rest Framework 3.4.3
Version 1.0 Beta 1 (unreleased)
-------------------------------
Initial release.
This is a django rest framework extension to allow developers to create nested
resources.
## How to use
### Configuration of nested resources
For this example we are going to create a simple API with the following
endpoints:
/developers/
/developers/<id>
/developers/<id>/languages/
/developers/<id>/languages/<id>
First we start with the following Django models:
```python
from django.db.models.base import Model
from django.db.models.fields import CharField
from django.db.models.fields.related import ForeignKey
class Developer(Model):
name = CharField(max_length=20)
class ProgrammingLanguage(Model):
name = CharField(max_length=20)
author = ForeignKey(Developer, related_name='programming_languages')
```
We will have the two viewsets for both the `developers` and `languages` resource
collections.
```python
from rest_framework.viewsets import ModelViewSet
from drf_nested_resources.fields import HyperlinkedNestedModelSerializer
class _DeveloperSerializer(HyperlinkedNestedModelSerializer):
class Meta(object):
model = Developer
fields = ('url', 'name', 'programming_languages')
class DeveloperViewSet(ModelViewSet):
queryset = Developer.objects.all()
serializer_class = _DeveloperSerializer
class _ProgrammingLanguageSerializer(HyperlinkedNestedModelSerializer):
class Meta(object):
model = ProgrammingLanguage
fields = ('url', 'name', 'author')
class ProgrammingLanguageViewSet(ModelViewSet):
queryset = ProgrammingLanguage.objects.all()
serializer_class = _ProgrammingLanguageSerializer
```
The related fields in the ViewSets `author` and `programming_languages` should
follow the model representation so that `author` will give us a url for the
developer who wrote the ProgrammingLanguage and the `programming_languages`
should give us a list of urls for the ProgrammingLanguages that the Developer
wrote.
This is how you would generate the urlpatterns for them:
```python
_RESOURCES = [
Resource(
'developer',
'developers',
DeveloperViewSet,
[
NestedResource(
'language',
'languages',
ProgrammingLanguageViewSet,
parent_field_lookup='author',
)
],
),
]
urlpatterns = make_urlpatterns_from_resources(_RESOURCES)
```
For more examples of different relationships and authorization check the test
suite.
Changelog
=========
Version 1.2 Beta 3
------------------
Fixed error when urlconf was not explicitly set on the request
Version 1.2 Beta 2
------------------
Fixed support for non-session-based authenticators when checking permissions in
viewsets in the ancestry.
Version 1.2 Beta 1
------------------
Implemented ability to force a field value in a nested resource to be set to
the URL of an ascending resource. This is done using the optional attribute
``field_forced_to_ancestor`` on the serializer's ``Meta`` class.
Version 1.1
-----------
Re-worked the mechanism for URL generation to support cross-linking resource
trees.
**Breaking change**: Any previous usage of many-to-many fields on variables
in the current request's URL will now break.
Version 1.0 Release Candidate 3
-------------------------------
Added proper support for namespaced URLs
Version 1.0 Release Candidate 1
-------------------------------
Added support for Django 1.10 and Rest Framework 3.4.3
Version 1.0 Beta 1 (unreleased)
-------------------------------
Initial release.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
drf-nested-resources-1.2b3.tar.gz
(12.1 kB
view hashes)
Built Distribution
Close
Hashes for drf-nested-resources-1.2b3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 58f08b5f1c2065dfb721e6a423103aafbba28b492e56c65004fe7a8571f041e0 |
|
MD5 | 895a7b3c6e061b65bb555a3dad6e884c |
|
BLAKE2b-256 | 79ee152cf0b98f5ee16f937ef9b57ba812b38b8329f07401f6e9f1160fe1f25e |
Close
Hashes for drf_nested_resources-1.2b3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 914b9fcfc5d00fc6a0466da5cb7c1fd1ed34b21e902b8d54315d309b09a1a4a3 |
|
MD5 | bf839db4c8183231872e586cc229a2ae |
|
BLAKE2b-256 | 2f5ac322f63ec39945e5fded88d02c1e827826e7ab3eb7761a68acb528790c6f |