A Python OpenAPI 3 Specification client and validator for Python 3.
Validation Mode
This module can be run against a spec file to validate it like so:
python3 -m openapi3 /path/to/spec
Usage as a Client
This library also functions as an interactive client for arbitrary OpenAPI 3 specs. For example, using Linode’s OpenAPI 3 Specification for reference:
from openapi3 import OpenAPI
import yaml
# load the spec file and read the yaml
with open('openapi.yaml') as f:
spec = yaml.safe_load(f.read())
# parse the spec into python - this will raise if the spec is invalid
api = OpenAPI(spec)
# call operations and receive result models
regions = api.call_getRegions()
# authenticate using a securityScheme defined in the spec's components.securitySchemes
api.authenticate('personalAccessToken', my_token)
# call an operation that requires authentication
linodes = api.call_getLinodeInstances()
# call an opertaion with parameters
linode = api.call_getLinodeInstance(parameters={"linodeId": 123})
# the models returns are all of the same (generated) type
print(type(linode)) # openapi.schemas.Linode
type(linode) == type(linodes.data[0]) # True
# call an operation with a request body
new_linode = api.call_createLinodeInstance(data={"region":"us-east","type":"g6-standard-2"})
# the returned models is still of the correct type
type(new_linode) == type(linode) # True
HTTP basic authentication and HTTP digest authentication works like this:
# authenticate using a securityScheme defined in the spec's components.securitySchemes
# Tuple with (username, password) as second argument
api.authenticate('basicAuth', ('username', 'password'))
Running Tests
This project includes a test suite, run via pytest. To run the test suite, ensure that you’ve installed the dependencies and then run pytest in the root of this project.
Roadmap
The following features are planned for the future:
Request body models, creation, and validation.
Parameters interface with validation and explicit typing.
Support for more authentication types.
Support for non-json request/response content.
Full support for all objects defined in the specification.
1 maintainer
Metadata
1 maintainer
Release files for openapi3 1.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| openapi3-1.6.0.tar.gz | 21.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openapi3-1.6.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 46.2 kB
Release files / openapi3-1.6.0.tar.gz
| Download URL | openapi3-1.6.0.tar.gz |
|---|---|
| Size | 21.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
07c67a16085d6e3b3f30457d37bddf9a40817a27a0cdbc1cea49010ee1277edb
|
|
BLAKE2b-256 checksum How to use checksums |
f77e96b372339441e5f90b1ab2024dc7223f8ce94a5bd1b5a94f067a2138fa71
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6
|
Release files / openapi3-1.6.0-py2.py3-none-any.whl
| Download URL | openapi3-1.6.0-py2.py3-none-any.whl |
|---|---|
| Size | 25.2 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
2e2cbcca57e9326f30ce756aa77129bb453e79d5be2c5e8d95d7d8b45968d7a1
|
|
BLAKE2b-256 checksum How to use checksums |
999361d6a434c41527bba5755ad417655b8079dabfd19c2531eee77b68cf3389
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6
|
Security for openapi3 1.6.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
