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 produces these artifacts:
- ./artifacts/openapi.yaml
- ./artifacts/openapi.json
- ./artifacts/openapi.html
- ./artifacts/sample/__init__.py
- ./artifacts/sample/sample.py
"""
openapiart.OpenApiArt(
api_files=['./tests/api/api.yaml'],
python_module_name='sample',
output_dir='./artifacts'
)
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.25.tar.gz
(25.7 kB
view hashes)
Built Distribution
Close
Hashes for openapiart-0.0.25-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 689d7f7b29862464eec3ad39d1927b5d4cd31e0e281e9baf51c12fb3defc48c1 |
|
MD5 | 2cc446a944031837c2a87944a028d376 |
|
BLAKE2b-256 | 30094d20824eb6fc4d52ba5af80acd8e0c0a1e8929cf2b7e1fb3ba5c78dd53fe |