Swagger & OpenAPI Parser and Validator

Swagger 2.0 and OpenAPI 3.0 parser and validator for Node and browsers

Swagger/OpenAPI Parser

Swagger 2.0 and OpenAPI 3.0 parser and validator for Node and browsers

Build Status Dependencies Coverage Status Codacy Score Inline docs Tested on APIs.guru

npm License

Browser Compatibility

Online Demo

Features

Example

SwaggerParser.validate(myAPI, function(err, api) {
  if (err) {
    console.error(err);
  }
  else {
    console.log("API name: %s, Version: %s", api.info.title, api.info.version);
  }
});

Or use Promises syntax instead. The following example is the same as above:

SwaggerParser.validate(myAPI)
  .then(function(api) {
    console.log("API name: %s, Version: %s", api.info.title, api.info.version);
  })
  .catch(function(err) {
    console.error(err);
  });

For more detailed examples, please see the API Documentation

Installation

Node

Install using npm:

npm install swagger-parser

Then require it in your code:

var SwaggerParser = require('swagger-parser');

Web Browsers

Reference swagger-parser.js or swagger-parser.min.js in your HTML:

<script src="https://cdn.rawgit.com/JS-DevTools/swagger-parser/dist/swagger-parser.js"></script>
<script>
  SwaggerParser.validate(myAPI, function(err, api) {
    if (err) {
      console.error(err);
    }
    else {
      console.log("API name: %s, Version: %s", api.info.title, api.info.version);
    }
  });
</script>

API Documentation

Full API documentation is available right here

Contributing

I welcome any contributions, enhancements, and bug-fixes. File an issue on GitHub and submit a pull request.

Building/Testing

To build/test the project locally on your computer:

  1. Clone this repo
    git clone https://github.com/APIDevTools/swagger-parser.git

  2. Install dependencies
    npm install

  3. Run the build script
    npm run build

  4. Run the tests
    npm test

  5. Start the local web server
    npm start (then browse to http://localhost:8080/test/)

License

Swagger Parser is 100% free and open-source, under the MIT license. Use it however you want.