OpenAPI typed
Python typings for OpenAPI using TypedDict.
Installation
Install package from PyPI.
pip install openapi-typedUsage
from openapi_typed import OpenAPIObject, Info
# Valid OpenAPIObject
openapi_valid = OpenAPIObject(
openapi="3.0.0",
info=Info(
title="My API",
version="0.0.0")
)
# Invalid OpenAPIObject
openapi_invalid = OpenAPIObject(
openap="3.0.0", # Type-check error, unknown attribute
info=Info(
title="My API" # Type-check error, missing attribute `version`
)
)Development
Install development dependencies:
pip install -e .[dev]Run tests:
pytest
# OR
python setup.py testBuild package:
python setup.py dist
