README
apeman-app-jsonapi
apeman app for send with JSON API format.
Installation
$ npm install apeman-app-jsonapi --save
Usage
- Define an app within Apemanfile.js
- Call the app via apeman app command.
Apemanfile.js
/** This is an example Apemanfile to use apeman-app-jsonapi */
'use strict'
module.exports = {
$pkg: { /* ... */ },
$apps: {
// Define your own app.
'my-app-01': {
// Map url and handlers.
'/': [
require('apeman-app-jsonapi')({
// Options
}),
(req, res, next) => {
// Send response as json api.
res.jsonapi({
meta: {},
data: {
id: 1,
types: 'users',
attributes: {}
}
})
}
]
}
}
}
Then,
$ apeman app my-app-01 -p 3000
Signature
apemanAppJsonapi(options) -> function
Send with JSON API format.
Args
Name | Type | Default | Description |
---|---|---|---|
options | object | Optional settings. | |
options.name | string | jsonapi | Name of jsonapi method in response. |
License
This software is released under the MIT License.