Swagger API Documentation builder for tornado server
Project description
tornado-rest-swagger
PyPI |
---|
Linux | Windows |
---|---|
tornado-rest-swagger: Swagger API Documentation builder for tornado server. Inspired by aiohttp-swagger package (based on this package sources).
Documentation | https://github.com/Cluas/tornado-rest-swagger/wiki |
---|---|
Code | https://github.com/Cluas/tornado-rest-swagger |
Issues | https://github.com/Cluas/tornado-rest-swaggerr/issues |
Python version | python2.7 and Python 3.4 and above |
Swagger Language Specification | https://swagger.io/specification |
Installation
pip install -U tornado-rest-swagger
What's tornado-rest-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: List posts
description: List all posts in feed
operationId: getPost
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PostModel'
'404':
description: Not Found
content: {}
"""
Version 1.1.1
- First version released
License
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Close
Hashes for tornado-rest-swagger-1.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad32eb8152394a89667137f081640e68fbfefb0e15b5a896be8e5085b5aae734 |
|
MD5 | e365b83b9f3e942f89153c5a87f76cd5 |
|
BLAKE2b-256 | c7a3d2565dc8c95e2e12322f45c4e1cb62c0e34906b9e5a65a99b071f5734e88 |
Close
Hashes for tornado_rest_swagger-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 53f61a840f5f654255f272f85a8a7c529f5a43c39cdb875f2624c69509002ba7 |
|
MD5 | 8bf776dec0f1e4df7c7c2a2660512757 |
|
BLAKE2b-256 | 1b9894da8ec12d7f7a7caaa8c459286188ab63d840aaac1ea9ea6b26fa35b998 |
Close
Hashes for tornado_rest_swagger-1.1.1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8ff2f76037caaef748064226274aa733c95694b4c29fbc5bbe8f98b7b412993a |
|
MD5 | 039472cb2810c2cff7f76880cc2e8886 |
|
BLAKE2b-256 | 1ced5b8921cac2f14f8e51f00e185d78d9f8a14203a89a5ba98c7c257947033e |