Fortune JSON API Serializer
This is a JSON API serializer for Fortune.js, which implements all of the features in the base specification, and follows the recommendations as much as possible.
$ npm install fortune-json-api
Usage
import fortune from 'fortune'
import jsonApi from 'fortune-json-api'
const store = fortune.create({
serializers: [ {
type: jsonApi,
options: { ... }
} ]
})
The options
object is as follows:
inflectType
: pluralize the record type name in the URI. Default: true
.inflectKeys
: camelize the field names per record. Default: true
.maxLimit
: maximum number of records to show per page. Default: 1000
.includeLimit
: maximum depth of fields per include. Default: 3
.bufferEncoding
: which encoding type to use for input buffer fields. Default: base64
.prefix
: hyperlink prefix, without trailing slash. Default ''
.
Internal options:
uriTemplate
: URI template string.allowLevel
: HTTP methods to allow ordered by appearance in URI template.
License
This software is licensed under the MIT license.