zswag 0.1.0

Convience functionality to create python modules from zserio services at warp speed.

Zswag

Convience functionality to create python modules from zserio services at warp speed. Translate/verify Zserio services to/with OpenAPI/Swagger and serve them in Flask/Connexion WSGI apps.

Installation

Clone this repository, and run

pip3 install -e .

Importing zserio package sources

import zswag

# Automatically sets up zserio runtime environment
#  and inserts a new python module called `mypackage`.
zswag.package("mypackage/all.zs")

# You can now access structs from your zserio sources!
from mypackage.all import CoolStruct

Note: If you require zserio at a specific version, just run zswag.setup(ver="x.y.z") before running zswag.package(...).

Creating a Swagger service from zserio

ZserioSwaggerApp gives you the power to marry a user-written app controller with a zserio-generated app server class (argument parser/response serialiser) and a fitting Swagger OpenAPI spec.

Example

import zswag
import my.app.controller

zswag.package("myapp/service.zs")
from myapp.service import Service

# The OpenApi argument `yaml_path=...` is optional
app = zswag.ZserioSwaggerApp(my.app.controller, Service)

Here, the API endpoints are routed to my/app/controller.py, which might look as follows:

# Written by you
def myApi(request):
    return "response"

# Injected by ZserioSwaggerApp
# _service = Service()
# _service.myApi = lambda request: _service._myApiMethod(request)
# _service._myApiImpl = my.app.controller.myApi

FYI

The OpenAPI spec is auto-generated if you do not specify an existing file. If you specify an empty YAML path, the yaml file is placed next to the zserio python-service source-file.

If you have installed pip install connexion[swagger-ui], you can view API docs of your service under [/prefix]/ui.