mulesoft-labs / osprey-resources

Automatically support RAML resources
Other
2 stars 7 forks source link
raml raml-build raml-tooling raml-utilities

Osprey Resources

NPM version NPM Downloads Build status Test coverage Greenkeeper badge

Iterate over RAML resources and generate a middleware router.

Installation

npm install osprey-resources --save

Usage

const express = require('express')
const resources = require('osprey-resources')
const utils = require('./utils')

const app = express()

// Array.<webapi-parser.EndPoint>
const endPoints = utils.getEndPoints()

app.use(resources(
  endPoints,
  function (method, path) {
    return function (req, res, next) {
      res.end('hello, world!')
    }
  }
))

The resources function accepts two arguments. The array of EndPoint objects from webapi-parser model and a function that will generate the route for that path. Return null if the route should not be used.

License

MIT license