https://github.com/gregschmit/drf-action-serializer

A serializer for the Django Rest Framework that supports per-action serialization of fields.
https://github.com/gregschmit/drf-action-serializer

django-rest-framework rest-api serialization serializer

Last synced: 2 months ago
JSON representation

A serializer for the Django Rest Framework that supports per-action serialization of fields.

• Host: GitHub
• URL: https://github.com/gregschmit/drf-action-serializer
• Owner: gregschmit
• License: mit
• Created: 2019-07-28T19:24:38.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-01-03T23:55:52.000Z (about 4 years ago)
• Last Synced: 2024-10-08T09:37:54.227Z (4 months ago)
• Topics: django-rest-framework, rest-api, serialization, serializer
• Language: Python
• Homepage: https://pypi.org/project/drf-action-serializer/
• Size: 25.4 KB
• Stars: 54
• Watchers: 2
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
Action Serializer

=================

.. image:: https://travis-ci.org/gregschmit/drf-action-serializer.svg?branch=master

    :alt: TravisCI

    :target: https://travis-ci.org/gregschmit/drf-action-serializer

.. image:: https://img.shields.io/pypi/v/drf-action-serializer

    :alt: PyPI

    :target: https://pypi.org/project/drf-action-serializer/

.. image:: https://coveralls.io/repos/github/gregschmit/drf-action-serializer/badge.svg?branch=master

    :alt: Coveralls

    :target: https://coveralls.io/github/gregschmit/drf-action-serializer?branch=master

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :alt: Code Style

    :target: https://github.com/ambv/black

Source: https://github.com/gregschmit/drf-action-serializer

PyPI: https://pypi.org/project/drf-action-serializer/

Action Serializer is a Django Rest Framework extension package that provides a

Serializer that implements per-action field configuration for use in your drf-powered

API.

**The Problem**: When building APIs, often you want different serializers for different

actions, such as less fields on a list view vs a detail view. Normally you would have to

build multiple Serializers to support this.

**The Solution**: This app provides the ``ModelActionSerializer`` which allows you to

easily configure per-action serialization.

How to Use

==========

.. code-block:: shell

    $ pip install drf-action-serializer

In your serializer, inherit from ``action_serializer.ModelActionSerializer``.

In your serializer, you can add an ``action_fields`` dictionary to the ``Meta`` class

and use ``fields``, ``exclude``, and ``extra_kwargs`` under the action key. The example

in this project shows how to render a smaller list of attributes for a list view

compared to the detail view.

.. code-block:: python

    from django.contrib.auth.models import Group

    from action_serializer import ModelActionSerializer

    class GroupActionSerializer(ModelActionSerializer):

        """

        An example serializer for the Django ``Group`` model, where the ``list`` action

        causes less fields to be serialized than normal.

        """

        class Meta:

            model = Group

            fields = ("id", "name", "permissions")

            action_fields = {"list": {"fields": ("id", "name")}}

In your ViewSet, just set the serializer like normal:

.. code-block:: python

    from rest_framework.viewsets import ModelViewSet

    class GroupViewSet(ModelViewSet):

        """

        An example viewset for the Django ``Group`` model.

        """

        serializer_class = GroupActionSerializer

        queryset = Group.objects.all()

Tests

=====

.. code-block:: shell

    $ python manage.py test