Swagger API Documentation builder for tornado server
Project description
tornado-swagger
PyPI |
---|
Linux | Windows |
---|---|
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.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
- Fix issue with
StaticFileHandler
(https://github.com/mrk-andreev/tornado-swagger/pull/28)
Version 1.2.5
- Update dependencies
PyYAML==5.3.1
fix vulnerabilitiespytest==6.0.1
,pytest-flake8==1.0.6
fix test crash
Version 1.2.4
- Fix "index out of range issue for StaticFileHandler" (https://github.com/mrk-andreev/tornado-swagger/issues/23)
Version 1.2.3
- Fix
\t
bug in Windows (https://github.com/mrk-andreev/tornado-swagger/issues/21)
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
tornado-swagger-1.2.9.tar.gz
(8.3 kB
view hashes)
Built Distribution
Close
Hashes for tornado_swagger-1.2.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 79c07cc329f7a343ca99342ef2d12803eba1e339c6d959cdca9ed7feb2dd966c |
|
MD5 | ab38b0eb9d2154c770dfa6152245dd92 |
|
BLAKE2b-256 | f5c624191a9d121515b2f488c4f05f4e5f546fc6c02ca0d8e0c93e0293b8a384 |