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.50.tar.gz
(38.2 kB
view hashes)
Built Distribution
Close
Hashes for openapiart-0.0.50-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 52367decc2f0efa2262d6d14d134416b6ae005abc8b6b7f83d2a1686f08578f4 |
|
MD5 | dbbe15683365a2bf24d74a3c1a58c383 |
|
BLAKE2b-256 | a42865dced7b0f1d9b4abd0fe5a84bf1e640422e26e899b0f5ba50766fd6c83a |