jagapi
TypeScript icon, indicating that this package has built-in type declarations

5.6.2 • Public • Published

Build Status Coverage Status npm version Dependencies Status

JaG API (jagapi)

Greenkeeper badge

About this Fork

NOTE: This is a fork of holidayextra's jsonapi-server We have merged a lot of pending PRs on the original repo that we felt we would gain advantage from. The original project was coing a bit too slowly for our needs.

Differences from upstream

primaryKey is configurable

In upstream, keys are by default uuid and are taken from DB, if generateId = true We instead use a different property primaryKey, whose possible values are

  • uuid : Uses UUID v4 (generated from the client)
  • autoincrement : Uses AUTOINCREMENT integers

*In future there might be other types of primaryKeys if required.

relationship key type is configurable

When creating a field, you can state how to relate it

jsonApi.define({
  ... 
  attributes: {
    ... 
    author: jsonApi.Joi.one('people').uidType('uuid')
    ...
  }
})

You'd want to use our version of jsonapi-store-[*] plugins with this as the original versions will not be compatible with this

The old readme here is verbatim copy of the original project

Package Sidebar

Install

npm i jagapi

Weekly Downloads

1

Version

5.6.2

License

MIT

Unpacked Size

1.92 MB

Total Files

210

Last publish

Collaborators

  • championswimmer