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

From the command line:

$ python -m openapi_parser data/petstore.yaml 

From the Python:

from openapi_parser.exporter import PackageWriter
from openapi_parser.parser.loader import OpenApiParser

def main():
    parser = OpenApiParser.open('data/petstore.yaml')
    parser.load_all()
    
    package_writer = PackageWriter(parser)
    package_writer.write_package()
    
    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
    • Authorization support
  • Metadata extractor
    • Version
    • Licence
    • Description
    • Servers
    • Security definitions
  • Server generator
  • Test coverage
  • Documentation
  • Command-line interface
    • Basic CLI support
    • Extended CLI support

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

openapi_parser-0.2.6-py3-none-any.whl (52.4 kB view hashes)

Uploaded Python 3

Supported by

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