Skip to main content

Swagger API Documentation builder for tornado server

Project description

tornado-swagger

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).

Documentation https://github.com/mrk-andreev/tornado-swagger/wiki
Code https://github.com/mrk-andreev/tornado-swagger
Issues https://github.com/mrk-andreev/tornado-swagger/issues
Python version Python 3.4 and above

Installation

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.

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

What's new?

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

License

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.

Filename, size & hash SHA256 hash help File type Python version Upload date
tornado_swagger-1.2.0-py3-none-any.whl (7.9 kB) Copy SHA256 hash SHA256 Wheel py3
tornado-swagger-1.2.0.tar.gz (6.8 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page