Skip to main content

OpenAPI Type

Project description Requirements Status Documentation Status Latest PyPI Release

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 | 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.

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 is hosted on ReadTheDocs:

Test framework

The project uses Nix for bootstrapping its dev environment.

You can run existing test suite with

nix-shell --run "make test"



Project details

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.2.0.tar.gz (10.1 kB view hashes)

Uploaded source

Built Distribution

openapi_type-0.2.0-py3-none-any.whl (9.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page