koa-rest-version v1.1.2

koa-rest-version

parse rest api version config, support two format:

• /v2/user/me?_type=json

• /user/me (Accept: application/vnd.app-name.v2+json)

API

• options.typeKey the type query key, default: _type
• options.override override the original path

const Koa = require('koa');
const version = require('version');
const app = new Koa();
app.use(version({
  typeKey: 'type',
  override: true,
}));
app.use(ctx => {
  // url: /user/me
  // {"version": 2, "type": "xml"}
  console.info(ctx.acceptConfig);
});
app.listen();
// GET /v2/user/me?type=xml

const Koa = require('koa');
const version = require('version');
const app = new Koa();
app.use(version());
app.use(ctx => {
  // url: /user/me
  // {"version": 2, "type": "xml"}
  console.info(ctx.acceptConfig);
});
app.listen();
// GET /v2/user/me?_type=xml

const Koa = require('koa');
const version = require('version');
const app = new Koa();
app.use(version('content-type'));
app.use(ctx => {
  // url: /user/me
  // {"version": 2, "type": "xml"}
  console.info(ctx.acceptConfig);
});
app.listen();
// GET /v2/user/me?content-type=xml

License

MIT