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

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

openapi_parser-0.2.5-py3-none-any.whl (52.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openapi_parser-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 52.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for openapi_parser-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 968057832e2589661b5526ac3cacb8e0e3dfd4ef540d07b5689497ebddba8879
MD5 f46bd1a8f36ed9be0024fb35d082852b
BLAKE2b-256 c2b92bea4d8202366710fdb7671b039fd473c55b763b69c604263b5699834d20

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