rav3-jsonapi-client

JSON API data provider for react-admin, V3 Style, Support for SAFRS and ApiLogicServer

npm package hosted at GitHub Package Registry

This Project uses code from henvo/ra-jsonapi-client

Install

npm install  @agoe/rav3-jsonapi-client  --registry=https://npm.pkg.github.com
yarn add agoe/rav3-jsonapi-client --npmRegistryServer https://npm.pkg.github.com

Usage

A JSONAPI compatible data provider for react-admin.

Supports: SAFRS ApiLogicServer

Features

Currently these actions will be supported:

• GET_LIST
• GET_ONE
• CREATE
• UPDATE
• DELETE todo
• GET_MANY
• GET_MANY_REFERENCE todo

Usage

Import this package, set the base url and pass it as the dataProvider to react-admin.

//in app.js
import React from "react";
import { Admin, Resource } from "react-admin";
import jsonapiClient from "rav3-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:

// Configure some settings.
const settings = { ... };

// Pass it as the second parameter after the base URL.
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 HTTP headers

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',
}

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:

{
  // Set the update method from PATCH to PUT.
  updateMethod: 'PUT',
  // Set the
  total: 'count'
}

Jsonapi include

is now supported Example: const includeRels = [ // in typescript interface includeRelations[] import {jsonapiClient, includeRelations} from "rav3-jsonapi-client"; { resource: 'Users', includes: ['addresses', 'companys'] }, { resource: 'Addresses', includes: ['users'] } ];

function App() { const settings = { total: 'count',includeRelations: includeRels };

License

MIT © Achim Götz agoe