Converts Swagger documents from version
1.x
to version2.0
Use npm
npm install swagger-converter --save
It's recommended to use command line tools like swagger-tools
or swagger-spec-converter
for converting your spec. This module will not handle validation and if your spec is not valid can produce invalid spec.
Swagger Converter expects two arguments.
resourceListing
is Swagger 1.x entry point file.apiDeclarations
is a map with paths fromresourceListing
as keys and resources as values
var swaggerConverter = require('swagger-converter');
var resourceListing = require('/path/to/petstore/index.json');
var apiDeclarations = {
'/pet': require('/path/to/petstore/pet.json'),
'/user': require('/path/to/petstore/user.json'),
'/store': require('/path/to/petstore/store.json')
};
var swagger2Document = swaggerConverter.convert(resourceListing, apiDeclarations);
console.log(JSON.stringify(swagger2Document, null, 2));
Install via Bower
bower install --save swagger-converter
Include the browser.js
script in your HTML
<script src="/path/to/swagger-converter/browser.js"></script>
Use the script
var swagger2Document = SwaggerConverter.convert(resourceListing, apiDeclarations);
Install dependencies with npm install
command and use npm test
to run the test. Tests will fail if you break coding style.
Just run this command to make a new browser.js
npm run build
MIT. See LICENSE