Skip to main content

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

Installation

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 app.py \
    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.

Documentation

https://zsl_openapi.readthedocs.io/

Development

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:

tox

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

Windows

set PYTEST_ADDOPTS=--cov-append
tox

Other

PYTEST_ADDOPTS=--cov-append tox

Changelog

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.

Source Distribution

zsl_openapi-0.1.4.tar.gz (20.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page