djangorestframework-queryfields

Allows clients to control which fields will be sent in the API response. Fields are specified in the query, e.g.

# You want a list of users but you're only interested in the fields "id" and "username":

GET /users/?fields=id,username

[
  {
    "id": 1,
    "username": "tom"
  },
  {
    "id": 2,
    "username": "wim"
  }
]


# You want to see every field except "id" for the specific user wim:

GET /users/2/?fields!=id

{
  "username": "wim",
  "email": "hey@wimglenn.com",
  "spirit_animal": "raccoon"
}

Supported Django versions: 1.7 - 3.2+. Check the CI matrix for details.

Documentation is hosted on Read The Docs.

Developers, developers, developers!

Want to contribute to the project? This is how to run the test suite:

# get the codez
git clone https://github.com/wimglenn/djangorestframework-queryfields.git

# create and/or activate your virtualenv, this or something like it:
cd djangorestframework-queryfields
python3 -m venv .venv
source .venv/bin/activate

# installing the app in your venv
pip install --editable ".[dev]"
git checkout -b myfeature

# hack away, then ...
pytest

Release files for djangorestframework-queryfields 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for djangorestframework-queryfields 1.1.0
File	Size	Uploaded
djangorestframework-queryfields-1.1.0.tar.gz	5.9 kB	Nov 22, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for djangorestframework-queryfields 1.1.0
File	Interpreter	ABI	Platform	Reset
djangorestframework_queryfields-1.1.0-py2.py3-none-any.whl 4.4 kB Nov 22, 2023	Python 2, Python 3	none	any	Details

Total release size: 10.3 kB

Release files / djangorestframework-queryfields-1.1.0.tar.gz

Download URL	djangorestframework-queryfields-1.1.0.tar.gz
Size	5.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`512516947e2d0f7b132469bc3b96b702653ed032e450d90b6efc0dc7fe031ef7`
BLAKE2b-256 checksum How to use checksums	`b8838c168b6169783c41c485068ef4a606e78461c09c4ee9a04fb986c6b83c41`
Upload date	Nov 22, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.12.0`

Release files / djangorestframework_queryfields-1.1.0-py2.py3-none-any.whl

Download URL	djangorestframework_queryfields-1.1.0-py2.py3-none-any.whl
Size	4.4 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`3952e02fd800de34a0fc64963bcaf7eb1e9ad688f120b1bca5b261843323f36e`
BLAKE2b-256 checksum How to use checksums	`319c725493f7939ee5dc49f837b9655beb4f924c723ecc54d641539d15b47e4a`
Upload date	Nov 22, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.12.0`