apeman-demo-api
Demo of api projects
Last updated 10 months ago by okunishinishi .
MIT · Repository · Bugs · Original npm · Tarball
$ cnpm install apeman-demo-api 
SYNC missed versions from official npm registry.

apeman-demo-api

Build Status npm Version JS Standard

Demo of api projects

Installation

$ npm install apeman-demo-api --save

Usage

Define a module in Apemanfile and run the server.

/** Example of Apemanfile.js */

'use strict'

const co = require('co')

let { NODE_ENV } = process.env

module.exports = {
  $cwd: __dirname,
  $pkg: { /* ... */ },
  $proto: [ /* ... */ ],
  $api: {
    // Define APIs
    'module01': require('apeman-demo-api')({
      logging: NODE_ENV === 'development'
    })
  }
}

Then, call the module from client script

#!/usr/bin/env node

/**
 * Example client
 */
'use strict'

const co = require('co')
const apemanApiClient = require('apeman-api-client')

co(function * () {
  // Setup an client
  let api = yield apemanApiClient('/api')

  // Connect to a module
  let module01 = yield api.connect('module01')
  let pong = yield module01.ping()
  /* ... */
})


Methods

The following methods are provided by the API.

.ping(pong)

Test the reachability of the api.

Param Type Description
pong string Pong message to return

License

This software is released under the MIT License.

Links

Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 54
Dependencies (2)
Dev Dependencies (15)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |