swagger-restify-express

This module will automagically wire your restify and express paths to swagger framework.

swagger-restify-express


This package will automagically wire your restify and express paths to swagger framework.

npm install restify
var restify =  require('restify')


sre = require('swagger-restify-express')


var server = restify.createServer({
  name:"My REST server"
});
 
server.pre(restify.pre.userAgentConnection());
server.use(restify.bodyParser({ mapParams: false }));
 
server.get('/xxx/:id', function(req, res) {
  res.send('hello from my REST server ' + req.params.name);
});
 
server.get('/xxx/:id/getit/:here', function(req, res) {
  res.send('hello from my REST server ' + req.params.name);
});
 
server.post('/offload', someClass.offload);
 
sre.init(server, {
          resourceName : 'swag',
          server : 'restify', // or express
          httpMethods : ['GET', 'POST'],
          basePath : 'https://yourdomain.com',
          ignorePaths : {
                  GET : ['path1', 'path2'],
                  POST : ['path1']
          }
        }
       )
 
server.listen(3000, function() {
  console.log('%s listening at %s', server.name, server.url);
});


sre.init(server, {
          resourceName : 'swag',
          server : 'restify', // or express
          httpMethods : ['GET', 'POST'],
          basePath : 'https://yourdomain.com',  // MANDATORY
          ignorePaths : {
                  GET : ['path1', 'path2'],
                  POST : ['path1']
          }
        }
       )


node app.js


http://localhost:3000/api-docs.html