Skip to main content

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:

Metadata

Release files for openapi-parser 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openapi-parser 0.3.1
File Size Uploaded
openapi_parser-0.3.1.tar.gz 40.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for openapi-parser 0.3.1
File Interpreter ABI Platform
openapi_parser-0.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 93.8 kB

Release files / openapi_parser-0.3.1.tar.gz

Download URL openapi_parser-0.3.1.tar.gz
Size 40.8 kB
Tags Source
SHA-256 checksum
How to use checksums
e96cad461567468e3ee4f76101c3a5e5853be478e0c7eac0e2179cfffeeb1e46
BLAKE2b-256 checksum
How to use checksums
5c4cf8ca20bae9054f6a28b99c8aa735fd1ccc93b59bfcb2f03dd13d4d03b8f1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release files / openapi_parser-0.3.1-py3-none-any.whl

Download URL openapi_parser-0.3.1-py3-none-any.whl
Size 53.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a223d5700a808eb5ff07c9319705cc4894ea23ab64eaf4b3035527224093f6da
BLAKE2b-256 checksum
How to use checksums
d5eebd5c2943a4fc3e16a37a63e69b1f613a6505027ab9be994cac1dad0e4911
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release history Release notifications | RSS feed

This release

0.3.1 This release

2 release files

0.3.0

2 release files

0.2.6

1 release file

0.2.5

1 release file

0.2.4

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.10

1 release file

0.1.9

1 release file

0.1.8

1 release file

0.1.7

1 release file

0.1.6

1 release file

0.1.5

1 release file

0.1.2

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page