Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefanofusai/drf-multi-serializers
Handle multiple serializers for the same view in Django Rest Framework
https://github.com/stefanofusai/drf-multi-serializers
django-rest-framework
Last synced: 26 days ago
JSON representation
Handle multiple serializers for the same view in Django Rest Framework
- Host: GitHub
- URL: https://github.com/stefanofusai/drf-multi-serializers
- Owner: stefanofusai
- License: mit
- Created: 2024-06-14T11:46:27.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-01-08T13:59:45.000Z (27 days ago)
- Last Synced: 2025-01-08T14:59:56.363Z (27 days ago)
- Topics: django-rest-framework
- Language: Python
- Homepage:
- Size: 129 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# drf-multi-serializers
Handle multiple serializers for the same view in Django Rest Framework.
This package uses [uv](https://docs.astral.sh/uv/) for project management. To get started, make sure that **uv** is installed on your machine and updated to the latest version. Detailed installation instructions for **uv** can be found [here](https://docs.astral.sh/uv/getting-started/installation/).
## Installation
```bash
uv add drf-multi-serializers
```
## Usage
Simply import the `MultiSerializerMixin` and use it in your API views:
```python
from rest_framework.generics import ListCreateAPIView
from rest_framework.viewsets import ModelViewSet
from drf_multi_serializers import MultiSerializerMixin
...
class MyListCreateAPIView(MultiSerializerMixin, ListCreateAPIView):
...
serializer_classes = {
"create": MyCreateSerializer,
"list": MyListSerializer,
}
...
class MyViewSet(MultiSerializerMixin, ModelViewSet):
...
serializer_classes = {
"create": MyCreateSerializer,
"list": MyListSerializer,
"metadata": MyMetadataSerializer, # create ViewSets require either serializer_class or metadata serializer for OPTION requests
"partial_update": MyUpdateSerializer,
"retrieve": MyRetrieveSerializer,
"update": MyUpdateSerializer,
}
...
```
`drf-multi-serializers` also supports Django Rest Framework's versioning system!
```python
from rest_framework.generics import ListCreateAPIView
from rest_framework.viewsets import ModelViewSet
from drf_multi_serializers import MultiSerializerMixin
...
class MyAPIView(MultiSerializerMixin, APIView):
...
serializer_classes = {
"v1": MyV1Serializer,
"v2": MyV2Serializer,
}
...
class MyViewSet(MultiSerializerMixin, ModelViewSet):
...
serializer_classes = {
"create": {"v1": MyV1CreateSerializer, "v2": MyV2CreateSerializer},
"list": MyListSerializer,
"metadata": MyMetadataSerializer, # create ViewSets require either serializer_class or metadata serializer for OPTION requests
"partial_update": MyUpdateSerializer,
"retrieve": MyRetrieveSerializer,
"update": MyUpdateSerializer,
}
...
```
## Development
```bash
uv sync --frozen --group=development
uv run --frozen pre-commit install --install-hooks
uv run --frozen pre-commit install --hook-type=commit-msg
```
## Contributing
Contributions are welcome! To get started, please refer to our [contribution guidelines](https://github.com/stefanofusai/drf-multi-serializers/blob/main/CONTRIBUTING.md).
## Issues
If you encounter any problems while using this package, please open a new issue [here](https://github.com/stefanofusai/drf-multi-serializers/issues).