https://github.com/python-openapi/openapi-spec-validator

OpenAPI Spec Validator is a CLI, pre-commit hook and python package that validates OpenAPI Specs against the OpenAPI 2.0 (aka Swagger), OpenAPI 3.0 and OpenAPI 3.1 specification.
https://github.com/python-openapi/openapi-spec-validator

oas oas3 openapi openapi2 openapi3 openapi31 python python-library specification swagger validation

Last synced: 3 days ago
JSON representation

OpenAPI Spec Validator is a CLI, pre-commit hook and python package that validates OpenAPI Specs against the OpenAPI 2.0 (aka Swagger), OpenAPI 3.0 and OpenAPI 3.1 specification.

• Host: GitHub
• URL: https://github.com/python-openapi/openapi-spec-validator
• Owner: python-openapi
• License: apache-2.0
• Created: 2017-09-06T08:08:25.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-09-16T12:22:36.000Z (3 months ago)
• Last Synced: 2024-10-29T15:22:32.612Z (about 2 months ago)
• Topics: oas, oas3, openapi, openapi2, openapi3, openapi31, python, python-library, specification, swagger, validation
• Language: Python
• Homepage:
• Size: 1000 KB
• Stars: 338
• Watchers: 10
• Forks: 62
• Open Issues: 45
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

• best-of-web-python - GitHub - 30% open · ⏱️ 24.05.2024): (OpenAPI Utilities)

README

        
**********************

OpenAPI Spec validator

**********************

.. image:: https://img.shields.io/docker/v/pythonopenapi/openapi-spec-validator.svg?color=%23086DD7&label=docker%20hub&sort=semver

     :target: https://hub.docker.com/r/pythonopenapi/openapi-spec-validator

.. image:: https://img.shields.io/pypi/v/openapi-spec-validator.svg

     :target: https://pypi.python.org/pypi/openapi-spec-validator

.. image:: https://travis-ci.org/python-openapi/openapi-spec-validator.svg?branch=master

     :target: https://travis-ci.org/python-openapi/openapi-spec-validator

.. image:: https://img.shields.io/codecov/c/github/python-openapi/openapi-spec-validator/master.svg?style=flat

     :target: https://codecov.io/github/python-openapi/openapi-spec-validator?branch=master

.. image:: https://img.shields.io/pypi/pyversions/openapi-spec-validator.svg

     :target: https://pypi.python.org/pypi/openapi-spec-validator

.. image:: https://img.shields.io/pypi/format/openapi-spec-validator.svg

     :target: https://pypi.python.org/pypi/openapi-spec-validator

.. image:: https://img.shields.io/pypi/status/openapi-spec-validator.svg

     :target: https://pypi.python.org/pypi/openapi-spec-validator

About

#####

OpenAPI Spec Validator is a CLI, pre-commit hook and python package that validates OpenAPI Specs

against the `OpenAPI 2.0 (aka Swagger)

`__,

`OpenAPI 3.0 `__

and `OpenAPI 3.1 `__

specification. The validator aims to check for full compliance with the Specification.

Documentation

#############

Check documentation to see more details about the features. All documentation is in the "docs" directory and online at `openapi-spec-validator.readthedocs.io `__

Installation

############

.. code-block:: console

    pip install openapi-spec-validator

Alternatively you can download the code and install from the repository:

.. code-block:: bash

   pip install -e git+https://github.com/python-openapi/openapi-spec-validator.git#egg=openapi_spec_validator

Usage

#####

CLI (Command Line Interface)

****************************

Straight forward way:

.. code-block:: bash

    openapi-spec-validator openapi.yaml

pipes way:

.. code-block:: bash

    cat openapi.yaml | openapi-spec-validator -

docker way:

.. code-block:: bash

    docker run -v path/to/openapi.yaml:/openapi.yaml --rm pythonopenapi/openapi-spec-validator /openapi.yaml

or more pythonic way:

.. code-block:: bash

    python -m openapi_spec_validator openapi.yaml

For more details, read about `CLI (Command Line Interface) `__.

pre-commit hook

***************

.. code-block:: yaml

   repos:

   -   repo: https://github.com/python-openapi/openapi-spec-validator

       rev: 0.5.5 # The version to use or 'master' for latest

       hooks:

       -   id: openapi-spec-validator

For more details, read about `pre-commit hook `__.

Python package

**************

.. code:: python

    from openapi_spec_validator import validate

    from openapi_spec_validator.readers import read_from_filename

    spec_dict, base_uri = read_from_filename('openapi.yaml')

    # If no exception is raised by validate(), the spec is valid.

    validate(spec_dict)

    validate({'openapi': '3.1.0'})

    Traceback (most recent call last):

        ...

    OpenAPIValidationError: 'info' is a required property

For more details, read about `Python package `__.

Related projects

################

* `openapi-core `__

   Python library that adds client-side and server-side support for the OpenAPI v3.0 and OpenAPI v3.1 specification.

* `openapi-schema-validator `__

   Python library that validates schema against the OpenAPI Schema Specification v3.0 and OpenAPI Schema Specification v3.1.

License

#######

Copyright (c) 2017-2023, Artur Maciag, All rights reserved. Apache v2