ra-jsonapi-client
A JSONAPI compatible data provider for
react-admin.
Features
Currently these actions are supported:
GET_LIST
GET_ONE
CREATE
UPDATE
DELETE
GET_MANY
GET_MANY_REFERENCE
Installation
npm install ra-jsonapi-client
yarn add ra-jsonapi-client
Usage
Import this package, set the base url and pass it as the dataProvider to
react-admin.
import React from "react";
import { Admin, Resource } from "react-admin";
import jsonapiClient from "ra-jsonapi-client";
const dataProvider = jsonapiClient('http://localhost:3000');
const App = () => (
<Admin dashboard={Dashboard} dataProvider={dataProvider}>
...
</Admin>
);
export default App;
Options
This client allows you to set some optional settings as the second parameter:
const settings = { ... };
const dataProvider = jsonapiClient('http://localhost:3000', settings);
Total count
Since JSONAPI does not specify
a standard for the total count key in the meta object, you can set it with:
const settings = { total: 'total-count' };
Which will work for:
{
"data": { ... },
"meta": {
"total-count": 436
}
}
If this option is not set it will fall back to total
.
Custom headers can be set by providing a headers
object in options
:
const settings = {
headers: {
Authorization: 'Bearer ...',
'X-Requested-With': 'XMLHttpRequest'
}
}
The default value is:
{
Accept: 'application/vnd.api+json; charset=utf-8',
'Content-Type': 'application/vnd.api+json; charset=utf-8',
}
Authentication
This client assumes that you are using an
authProvider for your react-admin
application. In order to use authentication with your backend your authProvider
needs to store credentials in localStorage.
Basic auth
For basic auth your authProvider needs to store username and password like this:
localStorage.setItem('username', 'bob');
localStorage.setItem('password', 'secret');
Bearer Token
For authentication via (access) token your authProvider needs to store the token
like this:
localStorage.setItem('token', '123token');
Update method (PUT vs. PATCH)
First versions used PUT
as the default update HTTP method.
In version 0.5.0 this was changed to PATCH
since it complies with the
JSONAPI standard.. You can still use PUT
by declaring the update method in
the settings:
{
updateMethod: 'PUT'
}
Contributors