npmpackage.info

Gathering detailed insights and metrics for swagger-parser

Other packages similar to swagger-parser

@apidevtools/swagger-parser

12.0.0

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

@swagger-api/apidom-parser-adapter-json

1.0.0-beta.44

Parser adapter for parsing JSON documents into base namespace.

@swagger-api/apidom-parser-adapter-yaml-1-2

1.0.0-beta.44

Parser adapter for parsing YAML documents into base namespace.

@swagger-api/apidom-parser-adapter-asyncapi-yaml-2

1.0.0-beta.44

Parser adapter for parsing YAML documents into AsyncAPI 2.x.y namespace.

Gathering detailed insights and metrics for swagger-parser

swagger-parser - 10.0.3 | npmpackage.info

swagger-parser

Swagger 2.0 and OpenAPI 3.0 parser/validator

10.0.3

1,150

MIT

JavaScript

Installations

npm install swagger-parser

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=10

Node Version

10.24.1

NPM Version

6.14.12 Score

95.5

Supply Chain

93.9

Quality

Maintenance

100

Vulnerability

98.9

License

Pull Requests

Open

1

Total

90

Closed

46

Merged

43

Issues

Open

54

Total

184

Closed

130

Releases

v12.0.0

Updated on Jun 16, 2025

v11.0.1

Updated on Jun 06, 2025

v11.0.0

Updated on Jun 03, 2025

v3.1.0

Updated on Dec 31, 2015

v3.0.0

Updated on Dec 31, 2015

View All 5 releases

Languages

JavaScript

TypeScript

HTML

JavaScript (95.98%)

TypeScript (3.81%)

HTML (0.2%)

Developer

APIDevTools

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

1,150 Stars

715 Commits

165 Forks

19 Watchers

2 Branches

32 Contributors

Updated on Jul 05, 2025

Maintainers

View All 32 Contributors

Package Meta Information

Latest Version

10.0.3

Package Id

swagger-parser@10.0.3

Size

6.76 kB

NPM Version

6.14.12

Node Version

10.24.1

Published on

Aug 15, 2021

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@apidevtools/swagger-parser

Swagger 2.0 and OpenAPI 3.0 parser/validator

Features

Parses Swagger specs in JSON or YAML format
Validates against the Swagger 2.0 schema or OpenAPI 3.0 Schema
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
Tested in Node.js and all modern web browsers on Mac, Windows, and Linux
Tested on over 1,500 real-world APIs from Google, Microsoft, Facebook, 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

1SwaggerParser.validate(myAPI, (err, api) => {
2  if (err) {
3    console.error(err);
4  }
5  else {
6    console.log("API name: %s, Version: %s", api.info.title, api.info.version);
7  }
8});

Or use async/await or Promise syntax instead. The following example is the same as above:

1try {
2  let api = await SwaggerParser.validate(myAPI);
3  console.log("API name: %s, Version: %s", api.info.title, api.info.version);
4}
5catch(err) {
6  console.error(err);
7}

For more detailed examples, please see the API Documentation

Installation

Install using npm:

1npm install @apidevtools/swagger-parser

Usage

When using Swagger Parser in Node.js apps, you'll probably want to use CommonJS syntax:

1const SwaggerParser = require("@apidevtools/swagger-parser");

When using a transpiler such as Babel or TypeScript, or a bundler such as Webpack or Rollup, you can use ECMAScript modules syntax instead:

1import SwaggerParser from "@apidevtools/swagger-parser";

Browser support

Swagger Parser supports recent versions of every major web browser. Older browsers may require Babel and/or polyfills.

To use Swagger Parser in a browser, you'll need to use a bundling tool such as Webpack, Rollup, Parcel, or Browserify. Some bundlers may require a bit of configuration, such as setting browser: true in rollup-plugin-resolve.

API Documentation

Full API documentation is available right here

Contributing

I welcome any contributions, enhancements, and bug-fixes. Open 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/APIDevTools/swagger-parser.git
Install dependencies
npm install
Run the build script
npm run build
Run the tests
npm test

License

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

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

Big Thanks To

Thanks to these awesome companies for their support of Open Source developers ❤

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Maintained

Determines if the project is "actively maintained".

10

Security-Policy

Determines if the project has published a security policy.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

6

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More