openapiart 0.0.54

The OpenAPI Artifact Generator Python Package

OpenAPIArt

The OpenAPIArt (OpenAPI Artifact Generator) python package does the following:

• pre-processes OpenAPI yaml files according to the MODELGUIDE
• using the path keyword bundles all dependency OpenAPI yaml files into a single openapi.yaml file
• post-processes any MODELGUIDE extensions
• validates the bundled openapi.yaml file

Using the validated openapi.yaml file it then:

• generates a static redocly documentation file
• generates a protobuf file
• generates protobuf based python files
• generates an enhanced ux python module

Getting started

Install the package

pip install openapiart

Generate artifacts from OpenAPI files

import openapiart

""" 
The following command will produce these artifacts:
    - ./artifacts/openapi.yaml
    - ./artifacts/openapi.json
    - ./artifacts/openapi.html
    - ./artifacts/sample.proto
    - ./artifacts/sample/__init__.py
    - ./artifacts/sample/sample.py
    - ./artifacts/sample/sample_pb2.py
    - ./artifacts/sample/sample_pb2_grpc.py
"""
openapiart.OpenApiArt(
    api_files=[
        './tests/api/api.yaml'
        './tests/api/info.yaml'
        './tests/common/common.yaml'
        ], 
    python_module_name='sample', 
    protobuf_file_name='sample',
    protobuf_package_name='sample',
    output_dir='./artifacts',
    extension_prefix='sample'
)

Specifications

This repository is based on the OpenAPI specification which is a standard, language-agnostic interface to RESTful APIs.

Modeling guide specific to this package