jthoms1 / bookshelf-jsonapi Goto Github PK

JSON API implementation using bookshelf models.

Home Page: http://jthoms1.github.io/bookshelf-jsonapi

License: MIT License

JavaScript 100.00%

bookshelf-jsonapi's Introduction

bookshelf-jsonapi

Simple library that uses Bookshelf models and relationships to create a RESTful api based on jsonapi.org spec using an express 4 compatible middleware.

Usage

Define your Bookshelf models and their relationships. Pass an object to the jsonapi middleware that contains 'resourceName' => 'modelReference'. This should allow your application to serve jsonapi compatible rest services with very little setup.

var jsonapi = require('jsonapi-bookshelf');
var models = require('./models'); // key model name, value model object

app.use('/api', jsonapi(models));

Please refer to the tests to see detailed examples of how the middlware works

bookshelf-jsonapi's People

Contributors

Stargazers

Watchers

Forkers

bbb jpchip

bookshelf-jsonapi's Issues

Updating 'to-one' relationships through PUT

If a to-one relationship is provided in the links section of a resource object in a PUT request, it MUST be one of:

an object with type and id members corresponding to the related resource
null, to remove the relationship

http://jsonapi.org/format/#crud-updating-resource-to-one-relationships

Implement 'Accept' header checking

JSON API requests MUST include an Accept header specifying the JSON API media type. Servers MUST return a 406 Not Acceptable status code if this header is missing or specifies an unsupported media type.
http://jsonapi.org/format/#fetching

Compound Documents

Support requesting compound documents with linked resources using 'include' parameter.
http://jsonapi.org/format/#document-structure-compound-documents

Attributes property

Hey, just reading through your tests and notice that properties are not placed under an "attributes" key. Is this due to jsonapi being at an older version at the time of writing?

Examples for Interface

README.md should include better examples for how to use the interface of the middleware.

Convert to jsonapi rc3

Use new version of jsonapi2simple to compy with jsonapi rc3. Also update tests.

Updating 'to-many' relationships through PUT

If a to-many relationship is included in the links section of a resource object, it MUST be an object containing:

type and ids members for homogeneous to-many relationships; to clear the relationship, set the ids member to []
a data member whose value is an array of objects each containing type and id members for heterogeneous to-many relationships; to clear the relationship, set the data member to []

http://jsonapi.org/format/#crud-updating-resource-to-many-relationships

Implement multiple sort attributes

An endpoint MAY support multiple sort fields by allowing comma-separated (U+002C COMMA, ",") sort fields. Sort fields SHOULD be applied in the order specified.

GET /people?sort=+age,+name

http://jsonapi.org/format/#fetching-sorting

Implement pagination

Implement pagination of collections.

Pagination links MUST appear in the link object that corresponds to a collection. To paginate the primary data, include pagination links in the top-level links object. To paginate a linked collection returned in a compound document, include pagination links in the corresponding link object.

http://jsonapi.org/format/#fetching-pagination

Remove relationships with DELETE method

If the client makes a DELETE request to a relationship URL, the server MUST delete the specified members from the relationship or return a 403 Forbidden response. If all of the specified resources are able to be removed from, or are already missing from, the relationship then the server MUST return a successful 204 No Content response.

Note: As described above for POST requests, this approach helps avoid pointless race conditions between multiple clients making the same changes.

http://jsonapi.org/format/#crud-updating-to-many-relationships