![Code style: black](https://camo.githubusercontent.com/7d770c433d6198d89f8c1e2f187b904a9721d176259d0e97157337741cc8e837/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64652532307374796c652d626c61636b2d3030303030302e737667)
PyPI |
![PyPI](https://camo.githubusercontent.com/ea82a522828c654a8175334a3a3d34b9e7954416f95859da8bde188c55545042/68747470733a2f2f696d672e736869656c64732e696f2f707970692f762f746f726e61646f2d737761676765722e737667) |
Linux |
Windows |
![TravisCI](https://camo.githubusercontent.com/1881479e0852a8c9699a74df6f2c127e909f51be4f75ada186928a018ab2940c/68747470733a2f2f7472617669732d63692e6f72672f6d726b2d616e64726565762f746f726e61646f2d737761676765722e7376673f6272616e63683d6d6173746572) |
![AppVeyor](https://camo.githubusercontent.com/ffa8d17be6e193689f9cbee7a9f7ca81dd5dede7330ac15f42d4e958788f6330/68747470733a2f2f696d672e736869656c64732e696f2f6170707665796f722f63692f6d726b2d616e64726565762f746f726e61646f2d737761676765722f6d61737465722e737667) |
tornado-swagger: Swagger API Documentation builder for tornado server. Inspired
by aiohttp-swagger package (based on this package sources).
pip install -U 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).
![](https://github.com/mrk-andreev/tornado-swagger/raw/master/docs/wiki__swagger_single_endpoint.png?raw=true)
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'
"""
- Fix handler args name parsing (
examples/args_recognize.py
). Thanks to [@reubinoff]
- 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
- 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
- Update dependencies
PyYAML==5.3.1
fix vulnerabilities
pytest==6.0.1
, pytest-flake8==1.0.6
fix test crash
- Support wrapped methods
- Remove jinja2 from deps
- Replace local js/css to cdn
- Remove static files serving
- Swagger model definition
- Parameters filling in route path
- Schema definition
export_swagger(routes)
as public function
- Update frontend
![FOSSA Status](https://camo.githubusercontent.com/579a5549dbde6ff6e6c9a3fac2f20ca5ea0814f933b1eee4413370f8ea644cdb/68747470733a2f2f6170702e666f7373612e696f2f6170692f70726f6a656374732f6769742532426769746875622e636f6d2532466d726b2d616e6472656576253246746f726e61646f2d737761676765722e7376673f747970653d6c61726765)