Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nfantone/mu-koan
An opinionated Koa v2 JSON API boilerplate to achieve enlightenment
https://github.com/nfantone/mu-koan
enlightenment json-api-boilerplate koa middleware
Last synced: 4 months ago
JSON representation
An opinionated Koa v2 JSON API boilerplate to achieve enlightenment
- Host: GitHub
- URL: https://github.com/nfantone/mu-koan
- Owner: nfantone
- License: mit
- Created: 2016-03-03T17:20:38.000Z (almost 9 years ago)
- Default Branch: develop
- Last Pushed: 2020-05-17T19:13:07.000Z (over 4 years ago)
- Last Synced: 2024-10-09T14:14:24.253Z (4 months ago)
- Topics: enlightenment, json-api-boilerplate, koa, middleware
- Language: JavaScript
- Homepage:
- Size: 158 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mu-kōän 公案
[](https://greenkeeper.io/)
[](https://travis-ci.org/nfantone/mu-koan) [](https://codecov.io/github/nfantone/mu-koan?branch=develop) [](https://github.com/nfantone/mu-koan/blob/master/LICENSE) [](https://github.com/Flet/semistandard)
> An opinionated Koa v2 JSON API boilerplate to achieve enlightenment.
mu-kōän serves as kickstarter set for Koa 2.0.0+ applications aimed at creating _stateless_ REST JSON APIs. It includes a set of predefined Koa middlewares allowing for quicker bootstrapping with sensible defaults.
```sh
npm i --save mu-koan
```
> mu-kōän requires [node](https://nodejs.org) 6.0.0+, matching [Koa requirements](https://github.com/koajs/koa/blob/master/package.json#L61).
## Usage
Create a new Koa app, configure it the way you want and pass it as an argument to the `bootstrap` exported function, wich will add its own middlewares and initialize routes.
```javascript
'use strict'
// Import some configuration
// For a detail of available options, see
// section below.
const CONFIG = require('./config.json')
const middlewares = require('mu-koan');
const Koa = require('koa');
let app = new Koa();
// ...
// Configure other middlewares on `app`.
// For a list of already included middlewares
// by mu-kōän checkout package.json or the section below:
// https://github.com/nfantone/mu-koan/tree/feature/module#features
middlewares.bootstrap(app, CONFIG);
// Start Koa server
app.listen();
```
> You can take a look at a minimal running `mu-koan` sample app at [app.js](./app.js)
### Advanced Usage
Middleware order declaration is important and some of them need to be placed as close to the top of the chain as possible (like global error handlers). By default, mu-kōän declares all of its packed middlewares in a single call to `bootstrap`. However, if you need to declare custom middlewares somewhere in between you can make use of the `initialize` method.
Declare them _before_ calling `bootstrap`, but after `initialize`.
```js
const custom = require('./middlewares/custom');
let app = new Koa();
middlewares.initialize(app, CONFIG);
// Declare custom middleware here, after initialize
app.use(custom());
middlewares.bootstrap(app, CONFIG);
```
This way, "global" middlewares are still declared at the top (by calling `initialize`), but your custom functions run immediately after, just before any other set by mu-kōän.
> Internally, `bootstrap` calls `initialize` if it hasn't already been call on that Koa app instance. So you'll always end up declaring all included middlewares, either way.
## Configuration
The following properties are used to configure the different middlewares packed by `mu-koan`:
```javascript
{
"bodyParser": {
// See https://www.npmjs.com/koa-bodyparser for more
"jsonLimit": "2mb"
},
"jwt": {
// Note that actual koa-jwt options are nested within "options"
"options": {
// See https://www.npmjs.com/koa-jwt for more
"passthrough": true,
"secret": "(w_E8Qd--@cBvgr8"
},
// Exclude JWT verification from certain paths
"unless": {
// See https://github.com/Foxandxss/koa-unless#current-options for more
"path": ["/status"]
}
},
"cors": {
// See https://www.npmjs.com/kcors for more
"allowedMethods": "GET"
},
"helmet": {
// See https://github.com/helmetjs/helmet#top-level-helmet for more
"frameguard": false
}
"morgan": {
"options": {
// See https://github.com/expressjs/morgan#options for more
"immediate": true
},
// See https://www.npmjs.com/koa-morgan for more
"format": "combined"
},
"cacheControl": {
// See https://github.com/DaMouse404/koa-cache-control#options for more
"public": true,
"maxAge": 3600
},
// Path to favicon file needed by https://www.npmjs.com/koa-favicon
"favicon": "./favicon.ico"
}
```
## Logging
mu-kōän prints out log messages using a `winston` logger. It can be provided as a second optional `options` argument to the`bootstrap` function.
```javascript
'use strict'
const middlewares = require('mu-koan');
const winston = require('winston');
const Koa = require('koa');
// Configure a winston logger
winston.loggers.add('some-logger', {
console: {
level: 'silly',
colorize: true,
label: 'mu-koan'
}
});
let app = new Koa();
// `logger` option below can also be a `winston.Logger` instance or `undefined`/`null`
const server = middlewares.bootstrap(app, { logger: 'some-logger' });
```
Actual logger configuration is not handled by mu-kōän. The option can be either a `String` or a `winston.Logger` instance. In the former case, the value will be used to fetch a logger by means of `winston.loggers.get(options.logger)`.
If none is provided, the _default_ `winston` logger will be used.
> Learn more about handling multiple loggers at [the official Winston docs](https://www.npmjs.com/package/winston#working-with-multiple-loggers-in-winston)
## Features
The boilerplate adds support for the following to a barebones Koa app:
- Body parsing ([koa-bodyparser](https://www.npmjs.com/package/koa-bodyparser))
- Pretty JSON responses ([koa-json](https://www.npmjs.com/package/koa-json))
- Global error handling ([koa-json-error](https://www.npmjs.com/package/koa-json-error))
- Cache control ([koa-cache-control](https://www.npmjs.com/package/koa-cache-control))
- Compression ([koa-compress](https://www.npmjs.com/package/koa-compress))
- CORS ([kcors](https://www.npmjs.com/package/kcors))
- ETag and conditional `GET` ([koa-etag](https://www.npmjs.com/package/koa-etag))
- RTT headers ([koa-response-time](https://www.npmjs.com/package/koa-response-time))
- Access logging ([koa-morgan](https://www.npmjs.com/package/koa-morgan)))
- JWT authentication ([koa-jwt](https://www.npmjs.com/package/koa-jwt))
- Favicon ([koa-favicon](https://www.npmjs.com/package/koa-favicon))
- Security headers ([koa-helmet](https://www.npmjs.com/package/koa-helmet))
---
## License
MIT