node package manager

swagger-parser


OpenAPI v3.0 support coming soon!

The next major release of Swagger Parser will include support for OpenAPI v3.0. Swagger v2.0 will still be supported as well. More details and an alpha version will be released soon.


Swagger Parser

Swagger 2.0 parser and validator for Node and browsers

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

npm Bower License

Browser Compatibility

Online Demo

Features

  • Parses Swagger specs in JSON or YAML format
  • Validates against the Swagger 2.0 schema and the Swagger 2.0 spec
  • Resolves all $ref pointers, including external files and URLs
  • Can bundle all your Swagger files into a single file that only has internal $ref pointers
  • Can dereference all $ref pointers, giving you a normal JavaScript object that's easy to work with
  • Configurable caching of external files and URLs
  • Tested in Node, IO.js, and all modern web browsers on Mac, Windows, Linux, iOS, and Android
  • Tested on over 500 real-world APIs from Google, Instagram, Spotify, etc.
  • Supports circular references, nested references, back-references, and cross-references
  • Maintains object reference equality — $ref pointers to the same value always resolve to the same object instance

Related Projects

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

Install using bower:

bower install swagger-parser

Then reference swagger-parser.js or swagger-parser.min.js in your HTML:

<script src="bower_components/swagger-parser/dist/swagger-parser.js"></script>

Or, if you're using AMD (Require.js), then import it into your module:

define(["swagger-parser"], function(SwaggerParser) { /* your module's code */ })

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/bigstickcarpet/swagger-parser.git

  2. Install dependencies
    npm install

  3. Run the build script
    npm run build

  4. Run the unit tests
    npm run mocha (test in Node)
    npm run karma (test in web browsers)
    npm test (test in Node and browsers, and report code coverage)

  5. Start the local web server
    npm start (then browse to http://localhost:8080/www/index.html or http://localhost:8080/tests/index.html)

License

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