HTTP request router for Swagger/OpenAPI
Swole is a configuration oriented router that glues your Swagger API definition to request handlers without any framework dependencies. Swole uses your API definition to handle parsing/validation of user inputs and can even validate responses.
$ npm install --save swole
var Swole = require('swole')
var api = {
swagger: '2.0',
info: {
title: 'API'
},
paths: {
'/beep': {
get: {
'x-handler': 'beep',
responses: {
200: {
schema: {
type: 'string',
enum: ['boop']
}
}
}
}
}
}
}
var swole = Swole(api, {
handlers: {
beep: (req, res, callback) => res.end('boop', callback)
}
})
server.on('request', function (req, res) {
swole(req, res, function (err) {
if (err) {
res.statusCode = err.statusCode || 500
return res.end(JSON.stringify(err))
}
})
})And make a request:
GET /beep
#=> 200 boop
Creates a new Swole API handler using a Swagger definition and options.
Returns a req, res, callback middleware function. Swole will append the matched path and operation values as req.swole as a {path, operation} object.
Required
Type: object
A Swagger API definition object.
Required
Type: object{function}
An object containing req, res, callback handler functions that match to x-handler keys in your operations objects.
Type: array[function]
An array of req, res, callback handler functions that will be called in series before executing handlers. These functions are run after the parameters for the request have been parsed and validated.
Type: array[string]
Default: ['json']
A list of body parsers to use for parsing request streams.
Type: boolean
Default: false
In strict mode, swole will validate outgoing payloads in addition to incoming data. This is slow and expensive and should only be used for development/debugging.
Type: boolean
Default: true
By default, Swole coerces paths into lowercase for simplicity. In practice, this makes everything but your path parameters case insensitive. To make routing case sensitive, set this to false.
MIT © Ben Drucker