appa

appa

Quickly create simple JSON API services.

Install

Make sure you've got node installed, then make appa a project dependency:

npm install --save appa

Minimal example

var http = require('http')
var app = require('appa')()

app.on('/', function (req, res, context) {
  app.send(res, { message: 'oh hey friends' })
})

http.createServer(app).listen(3000, function () {
  app.log.info('server started at http://127.0.0.1:3000')
})

API

createApp

Create the application. Returns the app function that can be passed into http.createServer.

Parameters

• options Object

app

The request, response handler that is passed to http.createServer, and the object that provides methods for your app.

Parameters

• req Object – the http request object
• res Object – the http response object

app.on

Route handler

Parameters

• pathname String – the route for this handler
• callback Function – the route handler

app.send

Send a JSON object as a response

Parameters

• res Object – the http response object
• statusCode Number – the status code of the response, default is 200
• data Object – the data that will be stringified into JSON

app.error

Send a JSON error response

Parameters

• response Object – the http response object
• statusCode Number – the status code of the response, default is 404
• message String – the message that will be stringified into JSON
• data Object – additional data about the error to send in the response

app.log

Create logs using the pino module: https://npmjs.com/pino

app.json

Parse or stringify a JSON stream using the JSONStream module: https://npmjs.com/JSONStream

app.pipe

Compose a stream using the pump module: https://npmjs.com/pump

License

MIT