Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

tornado-swagger

Maintainability Snyk Vulnerabilities for GitHub Repo FOSSA Status GitHub Code style: black

PyPI
PyPI
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.6, 3.7, 3.8, nightly
Swagger Language Specification https://swagger.io/specification/v2/

Installation

pip install -U 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):
        """
        ---
        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.10

  • Update PyYAML version to 5.4 (Fix for CVE-2020-14343)

Version 1.2.9

  • Fix handler args name parsing (examples/args_recognize.py). Thanks to [@reubinoff]

Version 1.2.8

  • Add security to setup. Thanks to @daominwang
  • Add black code formatter
  • Update swagger-ui library to 3.37.2
  • Add integrity attribute to script / link tags
  • Remove Python 3.5 support

Version 1.2.7

  • Add display_models param to setup (defaultModelsExpandDepth). Thanks to @Sloknatos
  • Fix swagger-ui bundle CVE-2019-17495
  • Specify supported python versions: 3.5, 3.6, 3.7, 3.8, nightly

Version 1.2.6

Version 1.2.5

  • Update dependencies
    • PyYAML==5.3.1 fix vulnerabilities
    • pytest==6.0.1, pytest-flake8==1.0.6 fix test crash

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

License

FOSSA Status