@bilgorajskim/ra-data-simple-rest
v2.1.0-2
Published
Simple REST data provider for react-admin
Downloads
9
Readme
Simple REST Data Provider For React-Admin
Simple REST Data Provider for react-admin, the frontend framework for building admin applications on top of REST/GraphQL services.
Installation
npm install --save ra-data-simple-rest
REST Dialect
This Data Provider fits REST APIs using simple GET parameters for filters and sorting. This is the dialect used for instance in FakeRest.
| REST verb | API calls
|----------------------|----------------------------------------------------------------
| GET_LIST
| GET http://my.api.url/posts?sort=['title','ASC']&range=[0, 24]&filter={title:'bar'}
| GET_ONE
| GET http://my.api.url/posts/123
| CREATE
| POST http://my.api.url/posts/123
| UPDATE
| PUT http://my.api.url/posts/123
| DELETE
| DELETE http://my.api.url/posts/123
| GET_MANY
| GET http://my.api.url/posts?filter={ids:[123,456,789]}
| GET_MANY_REFERENCE
| GET http://my.api.url/posts?filter={author_id:345}
Note: The simple REST data provider expects the API to include a Content-Range
header in the response to GET_LIST
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 React from 'react';
import { Admin, Resource } from 'react-admin';
import simpleRestProvider from 'ra-data-simple-rest';
import { PostList } from './posts';
const App = () => (
<Admin dataProvider={simpleRestProvider('http://path.to.my.api/')}>
<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 simpleRestProvider 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 = simpleRestProvider('http://localhost:3000', 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.
License
This data provider is licensed under the MIT License, and sponsored by marmelab.