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": "[email protected]",
"spirit_animal": "raccoon"
}
Supported Django versions: 1.7 - 3.2+. Check the CI matrix for details.
Documentation is hosted on Read The Docs.
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