node package manager

fleek-context

Fleek Context

Build Status

Middleware to parse and bind swagger request information

Requirements:

  • Node >= 6.0.0

Usage

This package is to be used as middleware for Koa2 to parse swagger documentation and apply it to the ctx of the request, while also using the ctx to determine which swagger path+method is currently being requested.

npm install --save fleek-context

Examples

const Koa = require('koa');
const fleekCtx = require('fleek-context');
 
const SWAGGER = require('./swagger.json');
 
let app = new Koa();
 
app.use(fleekCtx(SWAGGER));
 
app.use((ctx) => {
  console.log(ctx.fleek) // => key, context, swagger 
  return Promise.resolve();
});
 
app.listen(3000);

Documentation

Middleware

  • Accepts
    • Object - parsed swagger documentation
  • Returns
    • Middleware for use following the Koa2 pattern
// swagger.json 
{
  "basePath": "/v2",
  "paths": {
    "/foo/create": {
      "post": { /* ... */ }
    },
    "/foo/{id}": {
      "get": { /* ... */ }
      "put": { /* ... */ }
      "delete": { /* ... */ }
    }
  }
}
// app.js 
const SWAGGER =require('swagger.json');
let middleware = fleekCtx(SWAGGER);
 
app.use(middleware);
 
app.use((ctx) => {
  console.log(ctx.fleek);
  // GET /foo/myID => { 
  //   method: "GET", 
  //   path: "/foo/{id}", 
  //   params: { id: myID }, 
  //   context: { /* ... */}, 
  //   swagger: SWAGGER 
  // } 
  console.log(ctx.params);
  // GET /foo/myID => { id: myID } 
 
  return Promise.resolve();
});
 
app.listen(3000);

Authors

Built and maintained with by the Hart team.