npmpackage.info

Gathering detailed insights and metrics for swagger-spec-validator

Other packages similar to swagger-spec-validator

@apidevtools/swagger-parser

12.0.0

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

swagger-parser

10.0.3

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

@readme/openapi-parser

4.1.0

Swagger 2.0 and OpenAPI 3.x parser and validator for Node and browsers

routing-controllers-openapi

5.0.0

Runtime OpenAPI v3 spec generation for routing-controllers

Gathering detailed insights and metrics for swagger-spec-validator

swagger-spec-validator - 5.0.0 | npmpackage.info

swagger-spec-validator

Validate an OpenAPI/Swagger API specification using the swagger.io online validator.

5.0.0

MIT

JavaScript

27.14 kB

Installations

npm install swagger-spec-validator

Developer Guide

BETA

Typescript

No

Module System

CommonJS, ESM

Min. Node Version

^14.18 || >=16

Node Version

18.10.0

NPM Version

9.1.1 Score

75.4

Supply Chain

96.4

Quality

75.7

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

1

Total

101

Closed

50

Merged

50

Issues

Open

0

Total

18

Closed

18

Releases

v5.0.0

Updated on Nov 17, 2022

v4.0.1

Updated on Nov 17, 2019

v4.0.0

Updated on Nov 17, 2019

v3.0.1

Updated on Jan 25, 2019

v3.0.0

Updated on Jun 29, 2018

v2.0.0

Updated on Apr 19, 2018

View All 11 releases

Languages

JavaScript

HTML

Shell

Objective-J

Yacc

JavaScript (89.36%)

HTML (4.14%)

Shell (2.87%)

Objective-J (2.04%)

Yacc (1.6%)

Developer

kevinoid

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

9 Stars

626 Commits

1 Forks

2 Watchers

4 Branches

1 Contributors

Updated on Jun 13, 2025

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

5.0.0

Package Id

swagger-spec-validator@5.0.0

Unpacked Size

27.14 kB

Size

8.97 kB

File Count

NPM Version

9.1.1

Node Version

18.10.0

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

commander

Dev Dependencies

@kevinoid/eslint-config c8 eslint eslint-config-airbnb-base eslint-plugin-import eslint-plugin-jsdoc eslint-plugin-n eslint-plugin-promise eslint-plugin-unicorn jsdoc mocha nock nodecat proxyquire regexp.escape rimraf sinon

OpenAPI/Swagger Specification Validator

Validate an OpenAPI/Swagger v2 or v3 API specification against the OpenAPI Specification using the swagger.io online validator.

The validation performed by this module differs from the validation performed by swagger-cli. swagger-cli uses swagger-parser for validation, which is a pure JavaScript implementation that can be used offline. This module relies on the validator hosted at swagger.io which uses Java-based parser and validator implementations. Therefore, it requires Internet access to use and requires significantly less code to be installed as a result.

Introductory Example

To use swagger-spec-validator from the command line, simply invoke it with the specification files to validate as arguments:

1$ swagger-spec-validator swagger.yaml

If no arguments are given, the specification will be read from stdin.

swagger-spec-validator can be used as a library as follows:

1const swaggerSpecValidator = require('swagger-spec-validator');
2swaggerSpecValidator.validateFile('swagger.yaml')
3  .then((result) => {
4    if (Object.keys(result).length > 0) {
5      console.log('Invalid.');
6    } else {
7      console.log('Valid!');
8    }
9  })
10  .catch(err => console.error('Unable to validate: ' + err));

Installation

This package can be installed using npm, either globally or locally, by running:

1npm install swagger-spec-validator

Recipes

More examples can be found in the test specifications.

API Docs

To use this module as a library, see the API Documentation.

Contributing

Contributions are appreciated. Contributors agree to abide by the Contributor Covenant Code of Conduct. If this is your first time contributing to a Free and Open Source Software project, consider reading How to Contribute to Open Source in the Open Source Guides.

If the desired change is large, complex, backwards-incompatible, can have significantly differing implementations, or may not be in scope for this project, opening an issue before writing the code can avoid frustration and save a lot of time and effort.

License

This project is available under the terms of the MIT License. See the summary at TLDRLegal.

No vulnerabilities found.

10

Dangerous-Workflow

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

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

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

6

Maintained

Determines if the project is "actively maintained".

0

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

Pinned-Dependencies

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

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:97: update your workflow using https://app.stepsecurity.io/secureworkflow/kevinoid/swagger-spec-validator/node.js.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:99: update your workflow using https://app.stepsecurity.io/secureworkflow/kevinoid/swagger-spec-validator/node.js.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/node.js.yml:113: update your workflow using https://app.stepsecurity.io/secureworkflow/kevinoid/swagger-spec-validator/node.js.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/node.js.yml:124: update your workflow using https://app.stepsecurity.io/secureworkflow/kevinoid/swagger-spec-validator/node.js.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/kevinoid/swagger-spec-validator/node.js.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/kevinoid/swagger-spec-validator/node.js.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/node.js.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/kevinoid/swagger-spec-validator/node.js.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/node.js.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/kevinoid/swagger-spec-validator/node.js.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/node.js.yml:52
Warn: npmCommand not pinned by hash: .github/workflows/node.js.yml:108
Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 4 third-party GitHubAction dependencies pinned
Info: 0 out of 2 npmCommand dependencies pinned

0

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4

/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