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.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.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
Built Distribution
Close
Hashes for drf-nested-resources-1.1.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7aad897b8b01cf913b93bdd283ff0db0ff888b53823cd0efbdb3bf2fe2d9497 |
|
MD5 | 244e4d0566b2f316b2cb8ba691f49230 |
|
BLAKE2b-256 | 79b546fb72009ce4f8309e768f423f900e0e697993c84aa26472267b0293b596 |
Close
Hashes for drf_nested_resources-1.1.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f6b05644fd50ab0ed74c4ffa112a76b043e6d0b328320d8e67c711670b266830 |
|
MD5 | 3b5a5e9b1b1cfe9eff3131143f765cdc |
|
BLAKE2b-256 | 00aca371c7175793ac53ea0f434b3df7cf50703a26c29df4991aaa3fc51bc7bc |