A package for adding a django-reversion history endpoint to django-rest-framework ModelViewSet
Project description
django-reversion-rest-framework
A package for adding a django-reversion history endpoint to django-rest-framework ModelViewSet.
Configuration
Follow the official website for the installation and the integration of django-reversion in your project, otherwise future steps won't work.
You might need to enable the ReversionMiddleware
for storing a version for each API change.
Follow the instructions here,
you should add 'reversion.middleware.RevisionMiddleware'
to your MIDDLEWARE
setting.
Using the HistoryModelViewSet
The HistoryModelViewSet
extends django-rest-framework's ModelViewSet
adding
-
a GET
history
action in the detail (/my-model-url/<pk>/history/
)displaying a list of all revisions of that specific record
-
a GET
version
action in the history detail (/my-model-url/<pk>/history/<version_pk>/
)displaying a specific revisions of that specific record
-
a GET
deleted
action in the list (/my-model-url/deleted/
)displaying a list of all deleted records
-
a POST
revert
action in the detail (/my-model-url/<pk>/revert/<version_pk>/
)allowing users to revert to a previous revision of the object
You can use the HistoryModelViewSet
in place of the ModelViewSet
during viewsets definition.
from reversion_rest_framework.viewsets import HistoryModelViewSet
class MyModelViewSet(HistoryModelViewSet):
# ...
For advanced or selective implementation, you can use reversion_rest_framework.mixins
.
-
HistoryOnlyMixin
containshistory
andversion
actions -
DeletedOnlyMixin
contains only thedeleted
action -
ReadOnlyHistoryModel
containshistory
,version
anddeleted
actions -
RevertMixin
containshistory
,version
andrevert
actions
Customizing the VersionSerializer
The HistoryModelViewSet
comes up with actions using a VersionSerializer
.
To customize the serializer with one of your own, you can use version_serializer
.
For example, if you want to customize the user
serializer inside a revision,
you can use the following code:
from django.contrib.auth.models import User
from rest_framework import serializers
from reversion_rest_framework.viewsets import HistoryModelViewSet
from reversion.models import Revision, Version
from reversion_rest_framework.serializers import (
RevisionSerializer,
VersionSerializer,
)
class UserSerializer(serializers.ModelSerializer):
class Meta:
model = User
fields = ['id', 'username']
class CustomRevisionSerializer(RevisionSerializer):
user = UserSerializer()
class CustomVersionSerializer(VersionSerializer):
revision = CustomRevisionSerializer()
class MyModelViewSet(HistoryModelViewSet):
version_serializer = CustomVersionSerializer
# ...
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
Hashes for django-reversion-rest-framework-0.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 918113346aa014cf496c96e77fa3ded742405b343a85df925118130903c05a1f |
|
MD5 | a1d2d491ac5e3405bcd10b0b3e3df5de |
|
BLAKE2b-256 | a89791d7a779c68639ef4c355ea0666daa80a70db9e495cdd09a70605784f28f |
Hashes for django_reversion_rest_framework-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3de4f9f42d4880f752d762945ee4beb585bdaa952ac7987610e27730c2e8c9bd |
|
MD5 | 39e5fe123fba0b3d520a7a7805382bce |
|
BLAKE2b-256 | b507dde0be971805de87acc76b1829ac8e876545fb12bb4bfcb3b034231e92fc |