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 PackageWriter
from openapi_parser.parser.loader import *

def main():
    with open('data/petstore.yaml') as f:
        schema = yaml.safe_load(f)

    parser = OpenApiParser(schema)
    parser.load_all()

    package_writer = PackageWriter('.code-gen/petstore')
    package_writer.write_package(parser)

    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
    • Core functionality
    • Smart body encoding
    • Smart response decoding
    • style-encoding
    • schema and content inside parameters conflict support
    • Enums for parameters support
    • Cookies parameters support
    • Methods descriptions
  • Metadata extractor
    • Version
    • Licence
    • Description
    • Servers
  • 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.5-py3-none-any.whl (37.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openapi_parser-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 37.8 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 2f274cad8b89bd2e2ad06fa336a3a7110321687f813365188cb6ed2bc333d202
MD5 deaa8247719beeda68c7f2cd436bdb81
BLAKE2b-256 8d028240e29461b55289b2bf627ef858c31267a3b930dc5fa269ab701fccf8ae

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