The OpenAPI Artifact Generator Python Package
Project description
openapiart - OpenAPI Artifact Generator
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 a
.proto
file from the openapi file - optionally generates a static redocly documentation file
- optionally generates a
python ux sdk
from the openapi file - optionally generates a
go ux sdk
from the openapi file
Getting started
Install the package
pip install openapiart
Generate artifacts from OpenAPI files
"""
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
- ./pkg/openapiart.go
- ./pkg/go.mod
- ./pkg/go.sum
- ./pkg/sanity/sanity_grpc.pb.go
- ./pkg/sanity/sanity.pb.go
"""
import openapiart
# bundle api files
# validate the bundled file
# generate the documentation file
art = openapiart.OpenApiArt(
api_files=[
"./openapiart/tests/api/info.yaml",
"./openapiart/tests/common/common.yaml",
"./openapiart/tests/api/api.yaml",
],
artifact_dir="./artifacts",
protobuf_name="sanity",
extension_prefix="sanity",
)
# optionally generate a python ux sdk and python protobuf/grpc stubs
art.GeneratePythonSdk(
package_name="sanity"
)
# optionally generate a go ux sdk and go protobuf/grpc stubs
art.GenerateGoSdk(
package_dir="github.com/open-traffic-generator/openapiart/pkg",
package_name="openapiart"
)
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.3.19.tar.gz
(110.3 kB
view hashes)
Built Distribution
Close
Hashes for openapiart-0.3.19-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0170e14be8e1af362d5b708d21d744376e15f79e3953a7e25911fcc6e7023e3b |
|
MD5 | 8c5d79fb682fc666027a8c0ff0ea22ac |
|
BLAKE2b-256 | 312c0eab21235de2f0141dbf1190527951b190cc9b980f4e8cfc808647a97c61 |