Turn your API made with Django REST Framework(DRF) into a GraphQL like API.
Project description
django-restql
django-restql is a python library which allows you to turn your API made with Django REST Framework(DRF) into a GraphQL like API. With this you will be able to
-
Send a query to your API and get exactly what you need, nothing more and nothing less.
-
Control the data you get, not the server.
-
Get predictable results, since you control what you get from the server.
-
Save the load of fetching unused data from the server.
Isn't it cool?.
Installing
pip install django-restql
Getting Started
Using django-restql is very simple, you just have to inherit the DynamicFieldsMixin
class when defining a serializer.
from rest_framework import serializers
from django.contrib.auth.models import User
from django_restql.mixins import DynamicFieldsMixin
class UserSerializer(DynamicFieldsMixin, serializer.ModelSerializer):
class Meta:
model = User
fields = ['id', 'username', 'email', 'groups']
A regular request returns all fields as specified on DRF serializer, in fact django-restql doesn't handle this request at all:
GET /users
[
{
"id": 1,
"username": "yezyilomo",
"email": "yezileliilomo@hotmail.com",
"groups": [1,2]
},
...
]
django-restql handle all GET requests with query
parameter, this parameter is the one used to pass all fields to be included in a response. For example to select id
and username
fields from user
model, send a request with a query
parameter as shown below.
GET /users/?query={id, username}
[
{
"id": 1,
"username": "yezyilomo"
},
...
]
django-restql support querying both flat and nested resources, so you can expand or query nested fields at any level as long as your field is defined as nested field on a serializer. For example you can query a country and region field from location.
GET /users/?query={id, username, location{country, region}}
[
{
"id": 1,
"username": "yezyilomo",
"location": {
"contry": "Tanzania",
"region": "Dar es salaam"
}
},
...
]
django-restql got your back on querying iterable nested fields(one2many or many2many) too. For example if you want to expand groups
field into id
and name
, here is how you would do it.
GET /users/?query={id, username, groups{id, name}}
[
{
"id": 1,
"username": "yezyilomo",
"groups": [
{
"id": 2,
"name": "Auth_User"
}
{
"id": 3,
"name": "Admin_User"
}
]
},
...
]
If a query contains nested field without expanding and it's not defined as a nested field on a serializer, django-restql will return its id or array of ids for the case of nested iterable field(one2many or many2many). For example on a request below location
is a flat nested field(many2one) and groups
is an iterable nested field(one2many or many2many).
GET /users/?query={id, username, location, group}
[
{
"id": 1,
"username": "yezyilomo",
"location": 6,
"groups": [1,2]
},
...
]
Customizing django-restql
django-restql is very configurable, here is what you can customize on it.
-
Change the name of
query
parameter.If you don't want to use the name
query
as your parameter, you can inheritDynamicFieldsMixin
and change it as shown belowfrom django_restql.mixins import DynamicFieldsMixin class MyDynamicFieldMixin(DynamicFieldsMixin): query_param_name = "your_favourite_name"
Now you can use this Mixin on your serializer and use the name
your_favourite_name
as your parameter. E.gGET /users/?your_favourite_name={id, username}
-
Customize how fields to include in a response are filtered. You can do this by inheriting DynamicFieldsMixin and override
field
methods as shown below.from django_restql.mixins import DynamicFieldsMixin class CustomDynamicFieldMixin(DynamicFieldsMixin): @property def fields(self): # Your customization here return fields
Note: To be able to do this you must understand how django-restql is implemented, specifically DynamicFieldsMixin class, you can check it here. In fact this is how django-restql is implemented(just by overriding
field
method of a serializer, nothing more and nothing less).
Running Tests
python setup.py test
Credits
- Implementation of this library is based on the idea behind GraphQL.
- My intention is to extend the capability of drf-dynamic-fields library to support more functionalities like allowing to query nested fields both flat and iterable at any level, while maintaining simplicity.
Contributing ![PRs Welcome](https://pypi-camo.freetls.fastly.net/a8897c5f5e8a5eacb8ddf983bb640b73cc10464c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5052732d77656c636f6d652d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)
We welcome all contributions. Please read our CONTRIBUTING.md first. You can submit any ideas as pull requests or as GitHub issues. If you'd like to improve code, check out the Code Style Guide and have a good time!.
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_restql-0.4.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5344f425a737b246da54f271e49ea077ef7ac05da621e26eea79782d4779ff33 |
|
MD5 | 8d13f3123d2985e06fad8358dc912bb5 |
|
BLAKE2b-256 | 0f4ae00eddd2c832f2fc167596dc63e40eff0436b22bcb878f693fd29c9cdc98 |