An express routing library that leverages swagger (open api) definitions to validate incoming and outgoing data.
npm install skywayDEPRECATION NOTICE This module is no longer supported. I've come around to
not liking the patterns that this module enforces, and I'm sure other tools
do things in a much better way.
An express routing library that leverages swagger (open api) definitions to
validate incoming and outgoing data.
For information on the swagger api, visit the
official site or the
official spec
``sh`
yarn add skywayor
npm install --save skyway
`js
const express = require('express')
const skyway = require('skyway')
const bodyParser = require('body-parser')
const routes = require('./routes')
const app = express()
const api = skyway(${__dirname}/swagger.yaml)
app.get('/swagger.json', api.docs())
app.use('/docs', api.ui('/swagger.json'))
app.use(
api.routes({
parsers: {
'application/json': bodyParser.json()
}
})
)
app.use(routes)
app.listen(8000)
``
The API docs for this version are located here. Swagger
2.0 is the only version supported at the moment, but when OpenAPI Spec 3.0 comes
out, I will support both.