Wondering what’s next for npm?Check out our public roadmap! »

koa-version-header

1.3.0 • Public • Published

koa-version-header

Adds X-Version header to the response (Koa middleware)

NPM

Build status semantic-release standard style

Install

npm install --save koa-version-header

Use

Add to koa middleware list

const koa = require('koa')
const serviceVersion = require('koa-version-header')
const app = koa()
app.use(serviceVersion())
app.use(function * () {
  this.body = 'ok'
})
app.listen(3000)

Any request will get a few extra headers X-Service-... that you can use to validate the expected / tested services

$ http localhost:3000
HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 2
Content-Type: text/plain; charset=utf-8
Date: Wed, 23 Mar 2016 19:37:26 GMT
X-Service-Name: koa-version-header
X-Service-Version: 0.0.0-semantic-release
 
ok

Name and version

The name and version are read from the package.json file if it exists in the current working folder. You can overwrite / set different values using environment variables

SERVICE_NAME=my-service SERVICE_VERSION=1.0.0 node server.js 
X-Service-Name: my-service
X-Service-Version: 1.0.0

You can also force name and version by specifying them as options to the middleware

const koa = require('koa')
const serviceVersion = require('koa-version-header')
const app = koa()
app.use(serviceVersion({
  name: 'my-service',
  version: '2.3.1'
}))

Small print

Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2016

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2016 Gleb Bahmutov <gleb.bahmutov@gmail.com>

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.

Install

npm i koa-version-header

DownloadsWeekly Downloads

3

Version

1.3.0

License

MIT

Last publish

Collaborators

  • avatar