gabrieletassoni / ra-data-thecore

Thecore REST data provider for react-admin

Thecore REST Data Provider For React-Admin

Thecore REST Data Provider for react-admin, the frontend framework for building admin applications on top of REST/GraphQL services.

Inspired by Simple Rest

Installation

npm install --save ra-data-thecore

REST Dialect

This Data Provider fits REST APIs using Thecore API reference. This is the dialect is used for instance in Model Driven API. Thecore builds upon a Simple REST API the ability to paginate using kaminari and to filter the results using Ransack.

Method	Example API calls
getList	GET http://my.api.url/api/v2/users?q[s]=["email ASC"]&page=1&per=4
getOne	GET http://my.api.url/api/v2/posts/123
getMany	GET http://my.api.url/api/v2/posts?q[id_in][]=123&q[id_in][]=124&q[id_in][]=125
getManyReference	GET http://my.api.url/api/v2/comments?q[s]=["email ASC"]&page=1&per=4&q[post_id_eq]=1
create	POST http://my.api.url/api/v2/posts
update	PUT http://my.api.url/api/v2/posts/123
updateMany	PUT http://path.to.my.api/posts?ids=123,124,125
delete	DELETE http://my.api.url/api/v2/posts/123
deleteMany	DELETE http://my.api.url/api/v2/posts?ids=123,124,125

The API response when called by getList should look like this:

{
    "posts": [
        { "id": 0, "author_id": 0, "title": "Anna Karenina" },
        { "id": 1, "author_id": 0, "title": "War and Peace" },
        { "id": 2, "author_id": 1, "title": "Pride and Prejudice" },
        { "id": 2, "author_id": 1, "title": "Pride and Prejudice" },
        { "id": 3, "author_id": 1, "title": "Sense and Sensibility" }
    ]
}

An id field is required.

Note: The simple REST data provider expects the API to include a Content-Range header in the response to getList calls. The value must be the total number of resources in the collection. This allows react-admin to know how many pages of resources there are in total, and build the pagination controls.

Content-Range: posts 0-24/319

If your API is on another domain as the JS code, you'll need to whitelist this header with an Access-Control-Expose-Headers CORS header.

Access-Control-Expose-Headers: Content-Range

Usage

// in src/App.js
import * as React from "react";
import { Admin, Resource } from 'react-admin';
import thecoreRestProvider from 'ra-data-thecore';

import { PostList } from './posts';

const App = () => (
    <Admin dataProvider={thecoreRestProvider('http://path.to.my.api/api/v2/')}>
        <Resource name="posts" list={PostList} />
    </Admin>
);

export default App;

Adding Custom Headers

The provider function accepts an HTTP client function as second argument. By default, they use react-admin's fetchUtils.fetchJson() as HTTP client. It's similar to HTML5 fetch(), except it handles JSON decoding and HTTP error codes automatically.

That means that if you need to add custom headers to your requests, you just need to wrap the fetchJson() call inside your own function:

import { fetchUtils, Admin, Resource } from 'react-admin';
import thecoreRestProvider from 'ra-data-simple-rest';

const httpClient = (url, options = {}) => {
    if (!options.headers) {
        options.headers = new Headers({ Accept: 'application/json' });
    }
    // add your own headers here
    options.headers.set('X-Custom-Header', 'foobar');
    return fetchUtils.fetchJson(url, options);
};
const dataProvider = thecoreRestProvider('http://localhost:3000/api/v2/', httpClient);

render(
    <Admin dataProvider={dataProvider} title="Example Admin">
       ...
    </Admin>,
    document.getElementById('root')
);

Now all the requests to the REST API will contain the X-Custom-Header: foobar header.

Tip: The most common usage of custom headers is for authentication. fetchJson has built-on support for the Authorization token header:

const httpClient = (url, options = {}) => {
    options.user = {
        authenticated: true,
        token: 'SRTRDFVESGNJYTUKTYTHRG'
    };
    return fetchUtils.fetchJson(url, options);
};

Now all the requests to the REST API will contain the Authorization: SRTRDFVESGNJYTUKTYTHRG header.

Note about Content-Range

Historically, Simple REST Data Provider uses the http Content-Range header to retrieve the number of items in a collection. But this is a hack of the primary role of this header.

However this can be problematic, for example within an infrastructure using a Varnish that may use, modify or delete this header. We also have feedback indicating that using this header is problematic when you host your application on Vercel.

The solution is to use another http header to return the number of collection's items. The other header commonly used for this is X-Total-Count. So if you use X-Total-Count, you will have to :

• Whitelist this header with an Access-Control-Expose-Headers CORS header.

Access-Control-Expose-Headers: X-Total-Count

• Use the third parameter of thecoreRestProvider to specify the name of the header to use :

// in src/App.js
import * as React from "react";
import { Admin, Resource } from 'react-admin';
import { fetchUtils } from 'ra-core';
import thecoreRestProvider from 'ra-data-simple-rest';

import { PostList } from './posts';

const App = () => (
    <Admin dataProvider={thecoreRestProvider('http://path.to.my.api/api/v2/', fetchUtils.fetchJson, 'X-Total-Count')}>
        <Resource name="posts" list={PostList} />
    </Admin>
);

export default App;

License

This data provider is licensed under the MIT License.