README.md

Micro Services JSON API DataProvider

React Admin DataProvider with support for micro-services architecture with JSON API Spec.

Install

You can install this library via NPM or YARN.

NPM

npm i @blackbox-vision/ra-data-jsonapi-microservices

YARN

yarn add @blackbox-vision/ra-data-jsonapi-microservices

Use case

You use react-admin for building a frontend to manage CRUD resources, and you have a micro-service architecture for your services.

Example Usage

Normal usage

import React from 'react';
import { Admin, Resource } from 'react-admin';
import { microServicesJsonApiProvider } from '@blackbox-vision/ra-data-jsonapi-microservices';

import { PostList } from './posts';

const dataProvider = microServicesJsonApiProvider({
  posts: 'http://posts.api.url',
});

const App = () => (
  <Admin dataProvider={dataProvider}>
    <Resource name="posts" list={PostList} />
  </Admin>
);

export default App;

Passing a custom HTTP Client

import React from 'react';
import { Admin, Resource } from 'react-admin';
import { microServicesJsonApiProvider } from '@blackbox-vision/ra-data-jsonapi-microservices';

import { PostList } from './posts';

const customHttpClient = (url, options = {}) => {};
const dataProvider = microServicesJsonApiProvider(
  { posts: 'http://posts.api.url' },
  customHttpClient,
);

const App = () => (
  <Admin dataProvider={dataProvider}>
    <Resource name="posts" list={PostList} />
  </Admin>
);

export default App;

Issues

Please, open an issue following one of the issues templates. We will do our best to fix them.

Contributing

If you want to contribute to this project see contributing for more information.

License

Distributed under the MIT license. See LICENSE for more information.