
Product
Introducing Socket Fix for Safe, Automated Dependency Upgrades
Automatically fix and test dependency updates with socket fix—a new CLI tool that turns CVE alerts into safe, automated upgrades.
swagger-spec-validator
Advanced tools
Validate an OpenAPI/Swagger API specification using the swagger.io online 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.
To use swagger-spec-validator
from the command line, simply invoke it with
the specification files to validate as arguments:
$ 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:
const swaggerSpecValidator = require('swagger-spec-validator');
swaggerSpecValidator.validateFile('swagger.yaml')
.then((result) => {
if (Object.keys(result).length > 0) {
console.log('Invalid.');
} else {
console.log('Valid!');
}
})
.catch(err => console.error('Unable to validate: ' + err));
This package can be installed using npm, either globally or locally, by running:
npm install swagger-spec-validator
More examples can be found in the test specifications.
To use this module as a library, see the API Documentation.
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.
This project is available under the terms of the MIT License. See the summary at TLDRLegal.
FAQs
Validate an OpenAPI/Swagger API specification using the swagger.io online validator.
The npm package swagger-spec-validator receives a total of 1,570 weekly downloads. As such, swagger-spec-validator popularity was classified as popular.
We found that swagger-spec-validator demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Automatically fix and test dependency updates with socket fix—a new CLI tool that turns CVE alerts into safe, automated upgrades.
Security News
CISA denies CVE funding issues amid backlash over a new CVE foundation formed by board members, raising concerns about transparency and program governance.
Product
We’re excited to announce a powerful new capability in Socket: historical data and enhanced analytics.