koa-verto

Middleware that adds headers X-Service-Name & X-Service-Version to the response of Koa. Inspired by koa-version-header

Tested with:

• Koa version 2.5.2
• Node versions:
  • 10
  • 9
  • 8

Installation

This is a Node.js module available through the npm registry. It can be installed using the npm or yarn command line tools.

npm install koa-verto --save

Usage

const Koa = require('koa');
const setVersionHeaders = require('koa-verto');

const app = new Koa();

app.use(setVersionHeaders());

app.listen(3000);

console.log('running on :3000, verify X-Service-Name, X-Service-Version headers')

If you want to specify custom service name or version:

app.use(setVersionHeaders({
  name: 'my-cool-app',
  version: 'v11.1.2-alpha'
}));

Tests

npm install
npm test

License

MIT

Copyright 2018 <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.