swagger-n
v0.0.1-alpha.3
Published
A very simple express 4.x, swagger 2.x routing middleware
Downloads
28
Readme
swagger-n
swagger-n is a very simple express 4.x routing middleware that takes a swagger 2.x specification and a mapping of operationId to handler function and configures express routes.
swagger-n casts parameters defined in the swagger specification to the appropriate types and exposes them at req.swagger
Like so:
{
query: { username: 'bob', offset: 1, limit: 2 }
}
How to use swagger-n
Define your swagger 2.x spec:
{
"swagger": 2.0,
"info": {
"title": "Example API",
...
},
...
"paths": {
"/users": {
"get": {
"summary": "Find Users",
"operationId": "getUsers",
...
}
Define your handler mapping:
{
getUsers: function (req, res) {
...
},
...
}
Add the swagger-n router to express providing it with your spec and handler mapping
// HERE
var swagger = require("swagger-n");
...
var app = express();
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: false }));
app.use(cookieParser());
...
// HERE
app.use(swagger.router(spec, handlers));
...