datamodel-to-swagger

Data model to Swagger generator is an NPM module that generates Swagger from a data model in JSON format.

Installation

npm install datamodel-to-swagger -g

Using the CLI

Using the CLI is easy:

 $ git clone [email protected]:dzuluaga/datamodel-to-swagger.git
 $ cd datamodel-to-swagger
 $ cd test
 $ datamodel-to-swagger generate sample-data-model.json

That's it. You should be able to pipe the output of the generated swagger file to either a file or the clipboard with pbcopy.

Using the API

The following example can be found under test/app.js:

var datamodelToSwagger = require('../index');

datamodelToSwagger.generateSwagger( require('./sample-data-model.json') )
    .then( function( swaggerDoc ) {
      console.log( JSON.stringify( swaggerDoc, null, 2 ) );
    })
    .catch( function( err ) {
      console.log( err.stack );
    });

The Node.js module returns a promise with a Swagger file resolving sample-data-model.json.

Feedback and pull requests

Feel free to open an issue to submit feedback or a pull request to incorporate features into the main branch.