Skip to main content

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:

Supported only v2 OpenAPI Specification


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 from PyPI with

$ pip install py2swagger


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)

    simple              Plugin for all applications

Run tests

python test

Project details

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

py2swagger-1.0.0-py2.py3-none-any.whl (28.3 kB view hashes)

Uploaded py2 py3

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