Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: 3 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 (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T23:27:41.000Z (3 months ago)
- Last Synced: 2024-10-29T15:22:31.934Z (3 months ago)
- Topics: client, oas, oas3, openapi, openapi3, openapi31, python, python-library, schema, server, swagger
- Language: Python
- Homepage:
- Size: 3.27 MB
- Stars: 301
- Watchers: 8
- Forks: 132
- Open Issues: 92
-
Metadata Files:
- Readme: README.md
- 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
## About
Openapi-core is a Python library that adds client-side and server-side support
for the [OpenAPI v3.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md)
and [OpenAPI v3.1](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md) 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](https://openapi-core.readthedocs.io)
## Installation
Recommended way (via pip):
``` console
pip install openapi-core
```
Alternatively you can download the code and install from the repository:
``` console
pip install -e git+https://github.com/python-openapi/openapi-core.git#egg=openapi_core
```
## First steps
Firstly create your OpenAPI object.
``` 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.
``` python
# raises error if request is invalid
result = openapi.unmarshal_request(request)
```
Retrieve validated and unmarshalled request data
``` 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](https://openapi-core.readthedocs.io/en/latest/integrations.html) to find officially supported implementations.
For more details read about [Unmarshalling](https://openapi-core.readthedocs.io/en/latest/unmarshalling.html) process.
If you just want to validate your request/response data without unmarshalling, read about [Validation](https://openapi-core.readthedocs.io/en/latest/validation.html) instead.
## Related projects
- [openapi-spec-validator](https://github.com/python-openapi/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](https://github.com/python-openapi/openapi-schema-validator)
: Python library that validates schema against the OpenAPI Schema Specification v3.0 and OpenAPI Schema Specification v3.1.
- [bottle-openapi-3](https://github.com/cope-systems/bottle-openapi-3)
: OpenAPI 3.0 Support for the Bottle Web Framework
- [pyramid_openapi3](https://github.com/niteoweb/pyramid_openapi3)
: Pyramid addon for OpenAPI3 validation of requests and responses.
- [tornado-openapi3](https://github.com/correl/tornado-openapi3)
: Tornado OpenAPI 3 request and response validation library.
## License
The project is under the terms of BSD 3-Clause License.