import tornado.ioloop
import tornado.options
import tornado.web
from tornado_swagger.model import register_swagger_model
from tornado_swagger.setup import setup_swagger
class PostsHandler(tornado.web.RequestHandler):
def get(self):
"""
---
tags:
- Posts
summary: List posts
description: List all posts in feed
produces:
- application/json
responses:
200:
description: list of posts
schema:
type: array
items:
$ref: '#/definitions/PostModel'
"""
def post(self):
"""
---
tags:
- Posts
summary: Add posts
description: Add posts in feed
produces:
- application/json
parameters:
- in: body
name: body
description: post data
required: true
schema:
$ref: '#/definitions/PostModel'
"""
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'
"""
def patch(self, posts_id):
"""
---
tags:
- Posts
summary: Edit posts
description: Edit posts details
produces:
- application/json
parameters:
- name: posts_id
in: path
description: ID of post to edit
required: true
type: string
- in: body
name: body
description: post data
required: true
schema:
$ref: '#/definitions/PostModel'
"""
def delete(self, posts_id):
"""
---
tags:
- Posts
summary: Delete posts
description: Remove posts from feed
produces:
- application/json
parameters:
- name: posts_id
in: path
description: ID of post to delete
required: true
type: string
"""
@register_swagger_model
class PostModel:
"""
---
type: object
description: Post model representation
properties:
id:
type: integer
format: int64
title:
type: string
text:
type: string
is_visible:
type: boolean
default: true
"""
class Application(tornado.web.Application):
_routes = [
tornado.web.url(r"/api/posts", PostsHandler),
tornado.web.url(r"/api/posts/(\w+)", PostsDetailsHandler),
tornado.web.url(
r"/static/(.*)", tornado.web.StaticFileHandler, {"path": "/var/www"}
),
]
def __init__(self):
settings = {"debug": True}
setup_swagger(
self._routes,
swagger_url="/docs",
api_base_url="/",
description="",
api_version="1.0.0",
title="Journal API",
contact="name@domain",
schemes=["https"],
security_definitions={
"ApiKeyAuth": {"type": "apiKey", "in": "header", "name": "X-API-Key"}
},
)
super(Application, self).__init__(self._routes, **settings)
if __name__ == "__main__":
tornado.options.define("port", default="8080", help="Port to listen on")
tornado.options.parse_command_line()
app = Application()
app.listen(port=8080)
tornado.ioloop.IOLoop.current().start()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
https://github.com/mrk-andreev/tornado-swagger/blob/master/examples/simple_server.py
