sails-hook-flagpole

This is a Sails JS hook for creating an API which conforms to JSON API specifications per jsonapi.org.

Note: This project is still in development, and is not yet fully functional.

Installation

When we get on NPM:

npm install sails-hook-flagpole

Usage

requires at least sails >= 0.11

Just lift your app as normal, and your api responses will be formatted in accordance with jsonapi.org.

Options

Create a jsonapi.js file inside the config/ directory of your app, and you can set the following options:

Option	Default	Description
compoundDoc	true	When set to 'true' (default), response will be a compound document. Otherwise, related resources will be nested within the top-level resource attributes.
included	true	When set to true (default), related resource data will be included in the response. Currently, include parameters in client requests are not supported.

Known Limitations

This is still a project-in-work. So far, the following are not yet implemented:

• Included request parameter handling (400 response if present)
• Links
  • Top-level "self" links
  • Top-level "related" links
  • Resource-level "self" links
  • Related resource relationship links
  • Metadata links
• Pagination
• Formatting
  • Non-dasherized attributes
• Sparse fieldsets

There may be more. Please submit issue reports.