3.0.0 • Published 9 years ago

apeman-app-jsonapi v3.0.0

Weekly downloads
3
License
MIT
Repository
github
Last release
9 years ago

apeman-app-jsonapi

Build Status Code Climate Code Coverage npm Version JS Standard

apeman app for send with JSON API format.

Installation

$ npm install apeman-app-jsonapi --save

Usage

  1. Define an app within Apemanfile.js
  2. 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
NameTypeDefaultDescription
optionsobjectOptional settings.
options.namestringjsonapiName of jsonapi method in response.

License

This software is released under the MIT License.

Links

3.0.0

9 years ago

2.0.2

9 years ago

2.0.1

9 years ago

2.0.0

9 years ago

1.1.5

9 years ago

1.1.4

9 years ago

1.1.3

10 years ago

1.1.2

10 years ago

1.1.1

10 years ago

1.1.0

10 years ago

1.0.4

10 years ago

1.0.3

10 years ago

1.0.2

10 years ago

1.0.1

10 years ago

1.0.0

10 years ago