https://github.com/python-openapi/openapi-core

Openapi-core is a Python library that adds client-side and server-side support for the OpenAPI v3.0 and OpenAPI v3.1 specification.
https://github.com/python-openapi/openapi-core

client oas oas3 openapi openapi3 openapi31 python python-library schema server swagger

Last synced: 25 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/python-openapi/openapi-core
• Owner: python-openapi
• License: bsd-3-clause
• Created: 2017-09-20T10:25:35.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T15:03:58.000Z (6 months ago)
• Last Synced: 2024-05-22T16:27:46.700Z (6 months ago)
• Topics: client, oas, oas3, openapi, openapi3, openapi31, python, python-library, schema, server, swagger
• Language: Python
• Homepage:
• Size: 3.43 MB
• Stars: 279
• Watchers: 9
• Forks: 128
• Open Issues: 80
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

• jimsghstars - python-openapi/openapi-core - Openapi-core is a Python library that adds client-side and server-side support for the OpenAPI v3.0 and OpenAPI v3.1 specification. (Python)
• best-of-web-python - GitHub - 29% open · ⏱️ 22.05.2024): (OpenAPI Utilities)

README

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

openapi-core

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

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

     :target: https://pypi.python.org/pypi/openapi-core

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

     :target: https://travis-ci.org/python-openapi/openapi-core

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

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

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

     :target: https://pypi.python.org/pypi/openapi-core

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

     :target: https://pypi.python.org/pypi/openapi-core

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

     :target: https://pypi.python.org/pypi/openapi-core

About

#####

Openapi-core is a Python library that adds client-side and server-side support

for the `OpenAPI v3.0 `__

and `OpenAPI v3.1 `__ specification.

Key features

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

* **Validation** and **unmarshalling** of request and response data (including webhooks)

* **Integration** with popular libraries (Requests, Werkzeug) and frameworks (Django, Falcon, Flask, Starlette)

* Customization with media type **deserializers** and format **unmarshallers**

* **Security** data providers (API keys, Cookie, Basic and Bearer HTTP authentications)

Documentation

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

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

Installation

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

Recommended way (via pip):

.. code-block:: console

    pip install openapi-core

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

.. code-block:: console

    pip install -e git+https://github.com/python-openapi/openapi-core.git#egg=openapi_core

First steps

###########

Firstly create your OpenAPI object.

.. code-block:: python

    from openapi_core import OpenAPI

    openapi = OpenAPI.from_file_path('openapi.json')

Now you can use it to validate and unmarshal against requests and/or responses. 

.. code-block:: python

    # raises error if request is invalid

    result = openapi.unmarshal_request(request)

Retrieve validated and unmarshalled request data

.. code-block:: python

    # get parameters

    path_params = result.parameters.path

    query_params = result.parameters.query

    cookies_params = result.parameters.cookies

    headers_params = result.parameters.headers

    # get body

    body = result.body

    # get security data

    security = result.security

Request object should implement OpenAPI Request protocol. Check `Integrations `__ to find officially supported implementations.

For more details read about `Unmarshalling `__ process.

If you just want to validate your request/response data without unmarshalling, read about `Validation `__ instead.

Related projects

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

* `openapi-spec-validator `__

    Python library 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.

* `openapi-schema-validator `__

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

* `bottle-openapi-3 `__

    OpenAPI 3.0 Support for the Bottle Web Framework

* `pyramid_openapi3 `__

    Pyramid addon for OpenAPI3 validation of requests and responses.

* `tornado-openapi3 `__

    Tornado OpenAPI 3 request and response validation library.

License

#######

The project is under the terms of BSD 3-Clause License.