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
- generates enhanced ux python classes from the bundled openapi.yaml file
- creates a single combined python file for all generated and common classes
This python package DOES NOT create a python package for the generated artifacts.
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.13.tar.gz
(20.9 kB
view hashes)
Built Distribution
Close
Hashes for openapiart-0.0.13-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b8420125261581ed42fce1ffb098986df1881e8babf2f81f7342478cedb3c34 |
|
MD5 | ce7862c44d6c0188c20b6a11cbcee5e0 |
|
BLAKE2b-256 | 5e9f08a185f0a75bfd1ef1281631eb87cf782e2a42c90fc71416c92edf3917ce |