# appa

> Quickly create simple JSON API services.

Latest version **6.1.3** (published 2017-07-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install appa
pnpm add appa
yarn add appa
bun add appa
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 6.1.3 |
| Published | 2017-07-02 |
| First published | 2015-08-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Maintainers | sethvincent |

## Links

- npm: https://www.npmjs.com/package/appa
- Repository: https://github.com/sethvincent/appa
- Homepage: https://github.com/sethvincent/appa#readme
- Issues: https://github.com/sethvincent/appa/issues
- npm.io page: https://npm.io/package/appa

## Dependencies (10)

- [qs](https://npm.io/package/qs.md) ^6.1.0
- [pino](https://npm.io/package/pino.md) ^2.7.5
- [pump](https://npm.io/package/pump.md) ^1.0.1
- [xtend](https://npm.io/package/xtend.md) ^4.0.1
- [type-is](https://npm.io/package/type-is.md) ^1.6.12
- [raw-body](https://npm.io/package/raw-body.md) ^2.2.0
- [response](https://npm.io/package/response.md) ^0.18.0
- [wayfarer](https://npm.io/package/wayfarer.md) ^6.1.5
- [pino-http](https://npm.io/package/pino-http.md) ^1.0.8
- [JSONStream](https://npm.io/package/JSONStream.md) ^1.1.2

## Recent versions

- 6.1.3 (latest) — 2017-07-02
- 6.1.2 — 2017-02-26
- 6.1.1 — 2017-02-25
- 6.1.0 — 2017-02-19
- 6.0.0 — 2016-11-01
- 5.0.1 — 2016-11-01
- 5.0.0 — 2016-07-26
- 4.1.0 — 2016-06-28
- 4.0.0 — 2016-05-01
- 3.0.2 — 2016-04-20
- 3.0.1 — 2016-04-20
- 3.0.0 — 2016-04-20
- 2.1.0 — 2016-04-15
- 2.0.0 — 2016-04-09
- 1.0.2 — 2015-11-08
- … 2 more at https://npm.io/package/appa/versions

## README

# appa

Quickly create simple JSON API services.

[![npm][npm-image]][npm-url]
[![travis][travis-image]][travis-url]
[![standard][standard-image]][standard-url]
[![conduct][conduct]][conduct-url]

[npm-image]: https://img.shields.io/npm/v/appa.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/appa
[travis-image]: https://img.shields.io/travis/sethvincent/appa.svg?style=flat-square
[travis-url]: https://travis-ci.org/sethvincent/appa
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[standard-url]: http://npm.im/standard
[conduct]: https://img.shields.io/badge/code%20of%20conduct-contributor%20covenant-green.svg?style=flat-square
[conduct-url]: CONDUCT.md

![appa](https://raw.githubusercontent.com/sethvincent/appa/master/appa.jpg)

## Install

Make sure you've got [node installed](http://nodejs.org), then make `appa` a project dependency:

```sh
npm install --save appa
```

## Usage

```js
var http = require('http')
var app = require('appa')()
var send = require('appa/send')
var log = app.log

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

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

## Error handling

Any uncaught errors that occur in a request handler will be caught and a `500 Internal server error` response will be sent.

Send error responses using the `appa/error` module:

```js
var error = require('appa/error')

module.exports = function (req, res, ctx) {
  return error(404, 'Not found').pipe(res)
}
```

Sending an error response does not automatically log the error, so to add that you can do something like:

```js
var error = require('appa/error')
var log = require('appa/log')()

module.exports = function (req, res, ctx) {
  log.error(req.method, '500', errorStack)
  return error(500, 'Internal server error').pipe(res)
}
```

## Logging

appa uses [pino](https://npmjs.com/pino) for logging. Pass options to pino with `options.log`: `appa({ log: pinoOptions })`.

See [example pino usage](https://github.com/pinojs/pino#usage) and [all pino options](https://github.com/pinojs/pino/blob/master/docs/API.md#pinooptions-stream).

Or disable logging completely by setting `options.log` to `false`: `appa({ log: false })`.

## Documentation
- [API](docs/api.md)
- [Tests](tests/)

### Examples
- [Basic example](examples/basic.js)
- Example [server](examples/server.js) and [client](examples/client.js)

## Contributing

Contributions are welcome! Please read the [contributing guidelines](CONTRIBUTING.md) first.

## Conduct

It is important that this project contributes to a friendly, safe, and welcoming environment for all. Read this project's [code of conduct](CONDUCT.md)

## Changelog

Read about the changes to this project in [CHANGELOG.md](CHANGELOG.md). The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).

## Contact

- **issues** – Please open issues in the [issues queue](https://github.com/sethvincent/appa/issues)
- **twitter** – Have a question? [@sethdvincent](https://twitter.com/sethdvincent)
- **email** – Need in-depth support via paid contract? Send an email to sethvincent@gmail.com

## License

[ISC](LICENSE.md)

---
_Source: https://npm.io/package/appa · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._