Swagger schema builder
Project description
Python OpenAPI Specification generator
Tool for automated or semi-automated generate a OpenAPI Specification (aka Swagger Specification) for Web APIs written with Python and famous frameworks, such as:
Django REST Framework (DRF>=2; Django>=1.6)
Falcon (falcon>=0.3)
flask
bottle
and ever you own framework
Supported only v2 OpenAPI Specification
Why?
This tool is written as part of our Documentation Toolkit which we use in our job daily. The main idea of toolkit is to make a process of creating and updating documentation able to be automated
Other parts of our toolkit is:
Install
Install from PyPI with
$ pip install py2swagger
Usage
usage: py2swagger [-h] [-c CONFIG] [-r ROOT] [-o OUTPUT] {falcon,drf,simple} ... Swagger schema builder optional arguments: -h, --help show this help message and exit -c CONFIG, --config CONFIG Path to config file -r ROOT, --root ROOT Path to project root. Default is current directory or configuration file location -o OUTPUT, --output OUTPUT Output file (Default stdout) plugins: {falcon,drf,simple} falcon drf simple Plugin for all applications
Run tests
python setup.py test
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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for py2swagger-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a2e1316dfb1898b119964bdf12df61daa29b37a6421f1a089a5f7656e805789 |
|
MD5 | 2b63d2578382259c9d7915866d8f09d9 |
|
BLAKE2b-256 | 79f04766900d9e1d2d51bb3de097984294ded6fd0bdd0a728a8ca49be4ea5a68 |