Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kevinoid/swagger-spec-validator
Validate an OpenAPI/Swagger API specification using the swagger.io online validator.
https://github.com/kevinoid/swagger-spec-validator
nodejs openapi swagger validation
Last synced: 8 days ago
JSON representation
Validate an OpenAPI/Swagger API specification using the swagger.io online validator.
- Host: GitHub
- URL: https://github.com/kevinoid/swagger-spec-validator
- Owner: kevinoid
- License: mit
- Created: 2017-01-13T04:49:14.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-09-13T18:37:06.000Z (2 months ago)
- Last Synced: 2024-10-31T17:23:40.175Z (15 days ago)
- Topics: nodejs, openapi, swagger, validation
- Language: JavaScript
- Size: 1 MB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
OpenAPI/Swagger Specification Validator
=======================================
[](https://github.com/kevinoid/swagger-spec-validator/actions?query=branch%3Amain)
[](https://app.codecov.io/gh/kevinoid/swagger-spec-validator/branch/main)
[](https://libraries.io/npm/swagger-spec-validator)
[](https://www.npmjs.com/package/swagger-spec-validator)
[](https://www.npmjs.com/package/swagger-spec-validator)
Validate an OpenAPI/Swagger v2 or v3 API specification against the [OpenAPI
Specification](https://github.com/OAI/OpenAPI-Specification) using the
[swagger.io online validator](https://github.com/swagger-api/validator-badge).
The validation performed by this module differs from the validation performed
by [swagger-cli](https://github.com/BigstickCarpet/swagger-cli).
`swagger-cli` uses
[swagger-parser](https://github.com/BigstickCarpet/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:
```sh
$ 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:
```js
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));
```
## Installation
[This package](https://www.npmjs.com/package/swagger-spec-validator) can be
installed using [npm](https://www.npmjs.com/), either globally or locally, by
running:
```sh
npm install swagger-spec-validator
```
## Recipes
More examples can be found in the [test
specifications](https://kevinoid.github.io/swagger-spec-validator/spec).
## API Docs
To use this module as a library, see the [API
Documentation](https://kevinoid.github.io/swagger-spec-validator/api).
## Contributing
Contributions are appreciated. Contributors agree to abide by the [Contributor
Covenant Code of
Conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
If this is your first time contributing to a Free and Open Source Software
project, consider reading [How to Contribute to Open
Source](https://opensource.guide/how-to-contribute/)
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](LICENSE.txt).
See the [summary at TLDRLegal](https://tldrlegal.com/license/mit-license).