openapi-core
About
Openapi-core is a Python library that adds client-side and server-side support for the OpenAPI Specification v3.
Key features
- Validation of requests and responses
- Schema casting and unmarshalling
- Media type and parameters deserialization
- Security providers (API keys, Cookie, Basic and Bearer HTTP authentications)
- Custom deserializers and formats
- Integration with libraries and frameworks
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):
$ pip install openapi-core
Alternatively you can download the code and install from the repository:
$ pip install -e git+https://github.com/p1c2u/openapi-core.git#egg=openapi_core
Usage
Firstly create your specification object:
from json import load
from openapi_core import create_spec
with open('openapi.json', 'r') as spec_file:
spec_dict = load(spec_file)
spec = create_spec(spec_dict)
Request
Now you can use it to validate against requests
from openapi_core.validation.request.validators import RequestValidator
validator = RequestValidator(spec)
result = validator.validate(request)
# raise errors if request invalid
result.raise_for_errors()
# get list of errors
errors = result.errors
and unmarshal request data from validation result
# get parameters object with path, query, cookies and headers parameters
validated_params = result.parameters
# or specific parameters
validated_path_params = result.parameters.path
# get body
validated_body = result.body
# get security data
validated_security = result.security
Request object should be instance of OpenAPIRequest class (See Integrations).
Response
You can also validate against responses
from openapi_core.validation.response.validators import ResponseValidator
validator = ResponseValidator(spec)
result = validator.validate(request, response)
# raise errors if response invalid
result.raise_for_errors()
# get list of errors
errors = result.errors
and unmarshal response data from validation result
# get headers
validated_headers = result.headers
# get data
validated_data = result.data
Response object should be instance of OpenAPIResponse class (See Integrations).
Related projects
-
- bottle-openapi-3
- OpenAPI 3.0 Support for the Bottle Web Framework
-
- openapi-spec-validator
- Python library that validates OpenAPI Specs against the OpenAPI 2.0 (aka Swagger) and OpenAPI 3.0 specification
-
- openapi-schema-validator
- Python library that validates schema against the OpenAPI Schema Specification v3.0.
-
- pyramid_openapi3
- Pyramid addon for OpenAPI3 validation of requests and responses.
-
- tornado-openapi3
- Tornado OpenAPI 3 request and response validation library.
![[0.16.2 regression] `{](https://avatars.githubusercontent.com/u/26471?v=4)
1.4k Jan 8, 2023
361 Nov 16, 2022
3k Dec 31, 2022
106 Jan 5, 2023
462 Dec 29, 2022
1 Mar 1, 2022
31 Dec 2, 2022
440 Jan 6, 2023
0 Dec 13, 2022
124 Jan 6, 2023
8 May 23, 2022
26 Dec 14, 2022
15 Dec 7, 2022
7 Mar 19, 2022
12.1k Jan 5, 2023
60 Nov 16, 2022
2 Aug 22, 2022
1 Nov 8, 2021
1 Jan 6, 2022