OpenAPI Type
Project description
OpenAPI Type
OpenAPI specification represented as a Python type. Use it to parse specifications written in JSON and YAML formats.
pip install openapi-type
from 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.
Codegen
If you are looking for a complete client code generator, consider openapi-client-generator that uses this library under the hood.
Cloning this repo
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 log
Documentation
Documentation is hosted on ReadTheDocs: https://openapi-type.readthedocs.io/en/develop/
Test framework
The project uses Nix for bootstrapping its dev environment.
You can run existing test suite with
nix-shell --run "make test"
Changelog
See CHANGELOG.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
openapi-type-0.0.21.tar.gz
(10.4 kB
view hashes)
Built Distribution
Close
Hashes for openapi_type-0.0.21-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7dc9af9244bc9f2d708d860d36c9cc3d914084a079a5a39a1a069d5cdf43293 |
|
MD5 | ed74e3427e43199e6aa573f609e66e7d |
|
BLAKE2b-256 | 5b77919a3b45a4152adbf51e3f08a61e042eb4a22926b8038670969fe14bf5af |