Metadata-Version: 2.1
Name: djangorestframework-queryfields
Version: 1.0.0
Summary: Serialize a partial subset of fields in the API
Home-page: https://github.com/wimglenn/djangorestframework-queryfields
Author: Wim Glenn
Author-email: hey@wimglenn.com
License: UNKNOWN
Description: Django REST Framework QueryFields
        =================================
        
        Installation
        ------------
        
        .. code-block:: bash
        
            pip install djangorestframework-queryfields
        
        
        Quickstart
        ----------
        
        Specify your base model serializer like this:
        
        .. code-block:: python
        
            from rest_framework.serializers import ModelSerializer
            from drf_queryfields import QueryFieldsMixin
        
            class MyModelSerializer(QueryFieldsMixin, ModelSerializer):
                pass
        
        
        Usage
        -----
        
        .. code-block:: bash
        
            GET http://127.0.0.1:8000/snippets/
        
            HTTP/1.1 200 OK
            ...
            [
              {
                "id": 1,
                "title": "",
                "code": "foo = \"bar\"\n",
                "linenos": false,
                "language": "python",
                "style": "friendly"
              },
              {
                "id": 2,
                "title": "",
                "code": "print \"hello, world\"\n",
                "linenos": false,
                "language": "python",
                "style": "friendly"
              }
            ]
        
        
            GET http://127.0.0.1:8000/snippets/?fields=id,code
        
            HTTP/1.1 200 OK
            ...
            [
              {
                "id": 1,
                "code": "foo = \"bar\"\n",
              },
              {
                "id": 2,
                "code": "print \"hello, world\"\n",
              }
            ]
        
        
            GET http://127.0.0.1:8000/snippets/?fields!=code
        
            HTTP/1.1 200 OK
            ...
            [
              {
                "id": 1,
                "title": "",
                "linenos": false,
                "language": "python",
                "style": "friendly"
              },
              {
                "id": 2,
                "title": "",
                "linenos": false,
                "language": "python",
                "style": "friendly"
              }
            ]
        
        
        Feedback
        --------
        
        For feature requests or bug reports, please `create an issue here <https://github.com/wimglenn/djangorestframework-queryfields/issues>`_.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries
Classifier: Intended Audience :: Developers
Classifier: Framework :: Django
Provides-Extra: dev
