OpenAPI specification represented as a Python type. Use it to parse specifications written in JSON and YAML formats.
pip install openapi-typefrom openapi_type import OpenAPI, parse_spec, serialize_spec
spec: OpenAPI = parse_spec({
"your OpenAPI Spec as Python dictionary": "will be parsed into a proper Python type"
})
assert parse_spec(serialize_spec(spec)) == spec$ curl -s https://petstore3.swagger.io/api/v3/openapi.json | openapi-type check
Successfully parsed.If you are looking for a complete client code generator, consider openapi-client-generator that uses this library under the hood.
The proper way to clone this repo is:
git clone --recurse-submodules <repo-url> <local-project-root>
cd <local-project-root>
# for showing submodule status with `git status`
git config status.submodulesummary 1
# for logging submodule diff with `git diff`
git config diff.submodule logDocumentation is hosted on ReadTheDocs: https://openapi-type.readthedocs.io/en/develop/
The project uses Nix for bootstrapping its dev environment.
You can run existing test suite with
nix-shell --run "make test"See CHANGELOG.