Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/casantosmu/openapi-scan
CLI tool for validating OpenAPI definitions
https://github.com/casantosmu/openapi-scan
cli json openapi openapi3 swagger validation validator yaml
Last synced: 6 days ago
JSON representation
CLI tool for validating OpenAPI definitions
- Host: GitHub
- URL: https://github.com/casantosmu/openapi-scan
- Owner: casantosmu
- License: mit
- Created: 2023-12-21T00:05:00.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-13T19:04:23.000Z (17 days ago)
- Last Synced: 2025-01-13T20:19:58.612Z (17 days ago)
- Topics: cli, json, openapi, openapi3, swagger, validation, validator, yaml
- Language: JavaScript
- Homepage:
- Size: 323 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# openapi-scan
## Overview
`openapi-scan` is a command-line interface (CLI) tool designed to validate Swagger 2.0 or OpenAPI 3.0 definitions in JSON or YAML format. Leveraging the power of [@apidevtools/swagger-parser](https://www.npmjs.com/package/@apidevtools/swagger-parser), this tool ensures that your API specifications adhere to the standard.
## Features
- **Validation:** Ensures your Swagger 2.0 or OpenAPI 3.0 definitions are syntactically correct and adhere to the specified standards.
- **CLI Convenience:** Easily validate API definitions using standard input, a local file, or a URL.
- **Versatility:** Supports both JSON and YAML formats for API definitions.
## Installation
To use `openapi-scan`, first, install the package via npm:
```bash
npm install -g openapi-scan
```
## Usage
### Validate from Standard Input
```bash
cat openapi.json | openapi-scan
```
### Validate from Local File
```bash
openapi-scan openapi.json
```
### Validate from URL
```bash
openapi-scan http://localhost:3000/openapi.json
```
## Contributing
Feel free to contribute by submitting issues or pull requests on the [GitHub repository](https://github.com/casantosmu/openapi-scan).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.