OpenAPI Spec Validator is a Python application for checking that API descriptions conform to the OpenAPI specification. It can identify invalid structures, incorrect schema definitions and other problems that would prevent an API description from complying with the standard.
The software provides a command-line interface, an importable Python library and integration with the pre-commit framework. This makes it suitable for validating API specifications during development, from automated build systems or as part of a larger application.
Unlike a style-oriented linter such as Spectral, OpenAPI Spec Validator concentrates primarily on specification compliance rather than enforcing organisational naming conventions and API design preferences.
The project supports Swagger definitions as well as modern OpenAPI documents, including newer JSON Schema functionality. It can read local files or input supplied through standard input.
This is free and open source software.
Key Features
- Validate Swagger and OpenAPI documents against their respective specifications.
- Identify schema errors, missing required fields and invalid structures.
- Support for newer OpenAPI specification revisions and their associated JSON Schema capabilities.
- Command-line interface for validating individual API definition files.
- Read specifications supplied through standard input.
- Python library API for integrating validation into applications, scripts and test suites.
- Pre-commit hook for identifying specification problems before changes are committed.
- Container-based execution without installing the Python package directly on the host.
- Exception-based validation API, allowing applications to catch and process validation failures.
- Integration with continuous integration pipelines and automated testing workflows.
Website: github.com/python-openapi/openapi-spec-validator
Support:
Developer: Artur Maciag and contributors
License: Apache License 2.0
OpenAPI Spec validator is written in Python. Learn Python with our recommended free books and free tutorials.
Related Software
| OpenAPI Linters | |
|---|---|
| Spectral | Fexible JSON/YAML linter |
| vacuum | OpenAPI and Swagger linter |
| Redocly | All-in-one OpenAPI utility |
| Cherrybomb | Audit, validate, run API tests |
| Zally | Minimalistic, simple-to-use API linter |
| oasdiff | Validate OpenAPI specifications and detect breaking changes |
| Rate My OpenAPI | Improve the quality of your OpenAPI specifications |
| OpenAPI Validator | Configurable and extensible validator/linter |
| OpenAPI Spec validator | Validates OpenAPI Specs |
Read our verdict in the software roundup.
 Explore our carefully curated directory of recommended free and open source software, covering every major software category.The directory forms part of our extensive collection of articles for Linux enthusiasts. It includes hundreds of detailed reviews, together with free and open source alternatives to proprietary software from companies such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. LinuxLinks also covers interesting projects worth exploring, Linux-compatible hardware, free programming books and tutorials, and much more. Know a useful free and open source Linux application that we haven’t covered? Tell us about it using our submission form. |
Please read our Comment Policy before commenting.