apeman-app-json/README.md

apeman-app-json
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/apeman-app-labo/apeman-app-json
[bd_travis_url]: http://travis-ci.org/apeman-app-labo/apeman-app-json
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-app-labo/apeman-app-json.svg?style=flat
[bd_license_url]: https://github.com/apeman-app-labo/apeman-app-json/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-app-labo/apeman-app-json
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-app-labo/apeman-app-json.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-app-labo/apeman-app-json.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-app-labo/apeman-app-json
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-app-labo/apeman-app-json.svg
[bd_npm_url]: http://www.npmjs.org/package/apeman-app-json
[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-app-json.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

apeman app to serve dynamic json.

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>


Define `res.json()` method to send json data in response.

<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>
Installation
-----

```bash
$ npm install apeman-app-json --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>
Usage
---------

1. Define an app within Apemanfile.js
2. Call the app via apeman app command.

**Apemanfile.js**
```javascript
/** This is an example Apemanfile to use apeman-app-json */

'use strict'

module.exports = {
  $pkg: { /* ... */ },
  $apps: {
    // Define your own app.
    'my-app-01': {
      // Map url and handlers.
      '/': [
        require('apeman-app-json')({
          // Options
        }),
        (req, res, next) => {
          // `res.json()` method is available now.
          res.json({
            success: true
          })
        }
      ]
    }
  }
};
```

Then,
```bash
$ apeman app my-app-01 -p 3000
```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Signature.md.hbs" Start -->

<a name="section-doc-guides-03-signature-md"></a>
Signature
-------

#### apemanAppJson(options) -> function



##### Args

| Name | Type | Default | Description |
| --- | ---- | --- | --- |
| options | object  |  | Optional settings. |
| options.spaces | number  | 2 | JSON spaces |
| options.contentType | string  | 'application/json charset | Content type for header |
| options.name | string  | json | Property name of response to set the function. |


<!-- Section from "doc/guides/03.Signature.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/apeman-app-labo/apeman-app-json/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [apeman](https://github.com/apeman-labo/apeman)
+ [apeman-app](https://github.com/apeman-labo/apeman-app)

<!-- Links End -->