SwaggerDoc
About
A swagger tool for tornado, using python to write api doc!
Installation
pip install swagger-doc
Quick Start
code
import tornado.ioloop
import tornado.web
from pydantic import Field
from swagger_doc import setup_swagger, swagger_doc, SResponse200, SResponse401, STag, SObject, SPath, SQuery, SBody
class SwaggerTag(STag):
home = "home"
class RequestPath(SPath):
__example__ = {"id": 111}
id: int = Field(description="id")
class RequestQuery(SQuery):
__example__ = {"page": 10}
page: int = Field(description="page")
class RequestBody(SBody):
__example__ = {"name": "lisi"}
name: str = Field(description="name")
class SuccessResp(SObject):
__example__ = {"code": "0"}
code: str = Field(description="response code")
class UnauthorizedResp(SObject):
__example__ = {"code": 401}
class MainHandler(tornado.web.RequestHandler):
@swagger_doc(
tags=[SwaggerTag.home],
summary="show home page",
query_params=RequestQuery,
path_params=RequestPath,
request_body=RequestBody,
responses=[SResponse200(body=SuccessResp), SResponse401(body=UnauthorizedResp)],
)
def post(self, id_):
self.write("Hello, world")
class AppWithSwagger(tornado.web.Application):
def __init__(self, routes, *args, **kwargs):
setup_swagger(
routes,
swagger_url="/docs",
openapi_url="/openapi.json",
description="",
api_version="1.0.0",
title="API DOCS.",
)
super().__init__(routes, *args, **kwargs)
def make_app():
return AppWithSwagger([(r"/(\d+)", MainHandler)])
if __name__ == "__main__":
app = make_app()
app.listen(8885)
print(f"docs: http://localhost:8885/docs")
tornado.ioloop.IOLoop.current().start()
Authroization
default account&password: swagger:swagger
Docs
Examples
see examples
TODO
- other response(only support json response currently)
- search bar
- ...
249 Dec 22, 2022
1 Nov 1, 2021
155 Sep 20, 2022
6 Apr 28, 2022
2 Apr 27, 2022
31 Dec 29, 2022
5 Jul 28, 2022
498 Dec 30, 2022
1.3k Dec 30, 2022
186 Dec 30, 2022
1 Jan 10, 2022
71 Dec 26, 2022
33 Jan 03, 2023
1.9k Dec 26, 2022
234 Dec 26, 2022
263 Dec 23, 2022
1.4k Jan 08, 2023
276 Jan 04, 2023
6 Nov 18, 2022
2 Nov 25, 2021
1.3k Jan 08, 2023
43 Dec 26, 2022
15 Dec 07, 2022
48 Nov 15, 2022
75 Dec 30, 2022
19.2k Jan 02, 2023
8 Dec 15, 2022
38 Nov 24, 2022
89 Dec 25, 2022