The OpenAPI Artifact Generator Python Package
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
openapiart-0.0.36.tar.gz
(27.8 kB
view hashes)
Built Distribution
Close
Hashes for openapiart-0.0.36-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e38ce8978a998eae1de4944c6a32bc9be7d64ff4bc0256064a1899f003bf0ff5 |
|
MD5 | 1c4d6696d72d3d8f6664041ed99e2e56 |
|
BLAKE2b-256 | 86a4ab4820c2b17f471a629b822a2a59879c662874b1bad6a2d03bec2ca0f7f6 |