NOTICE: Swagger Parser v4.0 beta is now available
You can install the beta using npm install swagger-parser@beta
.
Swagger Parser v3.4
Swagger 2.0 parser and validator for Node and browsers
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 200 real-world APIs from Google, Instagram, Cisco, 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;
Or use Promises syntax instead. The following example is the same as above:
SwaggerParser ;
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 = ;
Web Browsers
Install using bower:
bower install swagger-parser
Then reference swagger-parser.js
or swagger-parser.min.js
in your HTML:
Or, if you're using AMD (Require.js), then import it into your module:
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:
-
Clone this repo
git clone https://github.com/bigstickcarpet/swagger-parser.git
-
Install dependencies
npm install
-
Run the build script
npm run build
-
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) -
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.