Overview
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
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.
Metadata
Release files for zsl_openapi 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| zsl_openapi-0.2.0.tar.gz | 23.2 kB | Without provenance | Details for zsl_openapi-0.2.0.tar.gz |
Release files / zsl_openapi-0.2.0.tar.gz
| Download URL | zsl_openapi-0.2.0.tar.gz |
|---|---|
| Size | 23.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6fa015d26e34cf3ea524e0f7f9dd6c73e080d4840625b55db05249e4ecc7e677
|
|
BLAKE2b-256 checksum How to use checksums |
532a721e086bf753540bed3bbb67ad06070506141703a13a2621d6c98f46d818
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for zsl_openapi 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.