Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

Generate OpenAPI specification out of your ZSL service.

Project description

Generate OpenAPI specification for your models and API out of your ZSL service. This module scans the given packages for the persistent models and generates model definitions out of them.

The full API (paths) may be declared manually.

  • Free software: BSD license


pip install zsl-openapi

How to use

Define container with the zsl_openapi.module.OpenAPIModule.

class MyContainer(WebContainer):
    open_api = OpenAPIModule

Then you may use CLI open_api command.

python \
    open_api generate \
    --package storage.models.persistent \
    --output api/openapi_spec_full.yml \
    --description api/openapi_spec.yml

See more in the documentation mentioned below.


Setup a virtualenv using Python 2.7 and activate it. To install all the development requirements run:

pip install -r requirements.txt

To run the all tests run:


Note, to combine the coverage data from all the tox environments run:

set PYTEST_ADDOPTS=--cov-append
PYTEST_ADDOPTS=--cov-append tox


0.1.0 (2017-06-09)

  • First release on PyPI.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for zsl_openapi, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size zsl_openapi-0.2.0.tar.gz (23.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page