Skip to main content

Swagger API Documentation builder for tornado server

Project description


Maintainability Snyk Vulnerabilities for GitHub Repo FOSSA Status GitHub

PyPI Anaconda
PyPI Anaconda
Linux Windows
TravisCI AppVeyor

tornado-swagger: Swagger API Documentation builder for tornado server. Inspired by aiohttp-swagger package (based on this package sources).

Python version Python 3.5 and above
Swagger Language Specification


pip install -U tornado-swagger
conda install -c mrk.andreev tornado-swagger 

What's tornado-swagger

tornado-swagger is a plugin for tornado server that allow to document APIs using Swagger show the Swagger-ui console (default url /api/doc).

class PostsDetailsHandler(tornado.web.RequestHandler):
    def get(self, posts_id):
        - Posts
        summary: Get posts details
        description: posts full version
        - application/json
        -   name: posts_id
            in: path
            description: ID of post to return
            required: true
            type: string
              description: list of posts
                $ref: '#/definitions/PostModel'

What's new?

Version 1.2.4

Version 1.2.3

Version 1.2.1

  • Support wrapped methods
  • Remove jinja2 from deps

Version 1.2.0

  • Replace local js/css to cdn
  • Remove static files serving

Version 1.1.0

  • Swagger model definition
  • Parameters filling in route path
  • Schema definition
  • export_swagger(routes) as public function
  • Update frontend

Version 1.0.0

  • First version released


FOSSA Status

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for tornado-swagger, version 1.2.4
Filename, size File type Python version Upload date Hashes
Filename, size tornado_swagger-1.2.4-py3-none-any.whl (8.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size tornado-swagger-1.2.4.tar.gz (7.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page