react-admin data and authentication provider for Django REST framework.

ra-data-django-rest-framework includes backend and client example application and tests.

npm install ra-data-django-rest-framework

import drfProvider from 'ra-data-django-rest-framework';
const dataProvider = drfProvider("/api");

• Sorting
• Pagination
• Filtering
• Authentication

Ordering for OrderingFilter is supported.

Currently pagination with PageNumberPagination is supported.

Default PageNumberPagination has page_size_query_param set to None, overide to be able to set Rows per page, ie:

from rest_framework.pagination import PageNumberPagination


class PageNumberWithPageSizePagination(PageNumberPagination):
    page_size_query_param = 'page_size'

ra-data-django-rest-framework supports:

• Generic Filtering
• DjangoFilterBackend

tokenAuthProvider uses TokenAuthentication to obtain token from django-rest-framework. User token is saved in localStorage.

tokenAuthProvider accepts options as second argument with obtainAuthTokenUrl key. Default URL for obtaining a token is /api-token-auth/.

fetchJsonWithAuthToken overrides httpClient and adds authorization header with previously saved user token to every request.

import drfProvider, { tokenAuthProvider, fetchJsonWithAuthToken } from 'ra-data-django-rest-framework';

const authProvider = tokenAuthProvider()
const dataProvider = drfProvider("/api", fetchJsonWithAuthToken);

jwtTokenAuthProvider uses JSON Web Token Authentication to obtain token from django-rest-framework. User token is saved in localStorage.

jwtTokenAuthProvider accepts options as second argument with obtainAuthJWTTokenUrl key. Default URL for obtaining a token is /api/token/.

fetchJsonWithAuthJWTToken overrides httpClient and adds authorization header with previously saved user token to every request.

import drfProvider, { jwtTokenAuthProvider, fetchJsonWithAuthJWTToken } from 'ra-data-django-rest-framework';

const authProvider = jwtTokenAuthProvider()
const dataProvider = drfProvider("/api", fetchJsonWithAuthJWTToken);

Setup virtual envirnoment, install requirements and load initial data:

cd example/backend
virtualenv .venv
source .venv/bin/activate
pip install -r requirements.txt
./manage.py migrate
./manage.py loaddata initial

Run server:

./manage.py runserver

Admin credentials in the example app are:

admin password

yarn install # install ra-data-django-rest-framework
cd example/client
yarn install
yarn start

You can now view example app in the browser: http://localhost:3000 Login with user admin, password is password or create new users in Django admin dashboard or shell.

By default the rest_framework.authentication.TokenAuthentication will be used. To use rest_framework_simplejwt.authentication.JWTAuthentication, set the value of the REACT_APP_USE_JWT_AUTH variable in the .env file (example/client/.env) to true, as shown below:

REACT_APP_USE_JWT_AUTH=true

This project was bootstrapped with TSDX. All features that TSDX provides should work here too.

yarn start

yarn test

• examples for image upload