1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
# openapi-core
<a href="https://pypi.python.org/pypi/openapi-core" target="_blank">
<img src="https://img.shields.io/pypi/v/openapi-core.svg" alt="Package version">
</a>
<a href="https://travis-ci.org/python-openapi/openapi-core" target="_blank">
<img src="https://travis-ci.org/python-openapi/openapi-core.svg?branch=master" alt="Continuous Integration">
</a>
<a href="https://codecov.io/github/python-openapi/openapi-core?branch=master" target="_blank">
<img src="https://img.shields.io/codecov/c/github/python-openapi/openapi-core/master.svg?style=flat" alt="Tests coverage">
</a>
<a href="https://pypi.python.org/pypi/openapi-core" target="_blank">
<img src="https://img.shields.io/pypi/pyversions/openapi-core.svg" alt="Python versions">
</a>
<a href="https://pypi.python.org/pypi/openapi-core" target="_blank">
<img src="https://img.shields.io/pypi/format/openapi-core.svg" alt="Package format">
</a>
<a href="https://pypi.python.org/pypi/openapi-core" target="_blank">
<img src="https://img.shields.io/pypi/status/openapi-core.svg" alt="Development status">
</a>
## About
Openapi-core is a Python library that provides 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) specifications.
## 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
First, 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 an error if the 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
```
The request object should implement the OpenAPI Request protocol. Check [Integrations](https://openapi-core.readthedocs.io/en/latest/integrations.html) to find officially supported implementations.
For more details read about the [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)
: A 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)
: A 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 the BSD 3-Clause License.
|
