Skip to main content

Renders Swagger APIs

Project description

Creates a single HTML file from a Swagger API. Supports an arbitrary subset of the 2.0 specification.

usage

swagger-render api.yml -o index.html

You can add the --watch / -w flag to watch the Swagger file for changes and re-render automatically with pyinotify, which needs to be installed separately from PyPI.

special options

If you add x-swagger-render-group-by-tags: false into the info section of the Swagger file the methods wont be grouped by tags so that there are no duplicates listed for each tag the method has. Instead the tags are shown in every method.

license

MIT, see LICENSE

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

swagger-render-1.6.0.tar.gz (7.1 kB view hashes)

Uploaded source

Supported by

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