sails-hook-jsonapi

KO | EN

gitlite — search

#react #python #android #docker #javascript #php #typescript #cli #boilerplate #vue #async #react-native

sails-hook-jsonapi

★ 29 Open GitHub ↗

:anchor: A Sails.js hook for creating an API which conforms to JSON API specifications per jsonapi.org

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# sails-hook-jsonapi
[![Build Status](https://travis-ci.org/sane/sails-hook-jsonapi.svg?branch=master)](https://travis-ci.org/sane/sails-hook-jsonapi)
[![Dependency Status](https://david-dm.org/sane/sails-hook-jsonapi.svg)](https://david-dm.org/sane/sails-hook-jsonapi)
[![devDependency Status](https://david-dm.org/sane/sails-hook-jsonapi/dev-status.svg)](https://david-dm.org/sane/sails-hook-jsonapi#info=devDependencies)

This is a [Sails JS](http://sailsjs.org) 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

`npm install sails-hook-jsonapi`

### 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](http://jsonapi.org/format/).

#### 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](http://jsonapi.org/format/#document-compound-documents) including related resources. |

### Known Limitations

This is unfinished. So far, the following are not yet implemented:

- Fetching resources
  - [ ] Included request parameter handling
  - [ ] 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
- [ ] Fetching relationships
- [ ] Updating relationships
- [ ] Deleting relationships

There may be more. Please submit issue reports. Or better yet, pull requests.

sails-hook-jsonapi

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README