apeman-demo-api

1.0.26 • Public • Published

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

Readme

Keywords

Package Sidebar

Install

npm i apeman-demo-api

Weekly Downloads

6

Version

1.0.26

License

MIT

Last publish

Collaborators

  • okunishinishi