Skip to main content

OpenAPI 3.0 specs parser and client/server generator

Project description

OpenAPI 3.0 Parser

This package provides functionality to analyze OpenAPI 3.0 Specification files and build clients and servers from that specification.

For more details, please refer the Project Documentation

Example Usage

import yaml

from openapi_parser.exporter import ModelWriter
from openapi_parser.parser.loader import *


def main():
    with open('data/petshop.yaml', 'rt', encoding='utf8') as f:
        schema = yaml.safe_load(f)

    parser = OpenApiParser(schema)
    parser.load_all()
    writer = ModelWriter()

    with open('.code-gen/petshop.py', 'wt', encoding='utf8') as output:
        writer.write_model(parser, file=output)
    return 0

if (__name__ == '__main__'):
    exit_code = main()
    exit(exit_code)

TODOs:

  • Model generator:
    • Core functionality
    • Class inheritance support
    • Enums support
    • Required properties in combination with readOnly/writeOnly
    • Discriminator property support
    • Cyclic refs resolution
    • Support of additionalProperties inside class
  • Client generator
  • Server generator
  • Test coverage
  • Documentation
  • Command-line interface

See Also:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openapi_parser-0.1.2-py3-none-any.whl (25.0 kB view details)

Uploaded Python 3

File details

Details for the file openapi_parser-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: openapi_parser-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 25.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.7.9

File hashes

Hashes for openapi_parser-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5824f90f8f27b1af4d0562004eead28030d6baba488684f7507aa6fc101f1294
MD5 1f6928fc2723c5bb323f408e930d5f1b
BLAKE2b-256 d5516d58c418aaacb9959506f253f9e2f32b3a3575208eec5f6e27016a03a797

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page