使用ui轻松记录sanic api。
sanic-openapi的Python项目详细描述
Sanic OpenAPI
给你的sanic api一个ui和openapi文档,一切都是免费的!
安装
pip install sanic-openapi
添加带有openapi规范的swagger ui:
fromsanic_openapiimportswagger_blueprintapp.blueprint(swagger_blueprint)
现在,您将在url/swagger/
处拥有一个夸张的ui,在/swagger/swagger.json
处拥有一个openapi 2.0规范。
你的路线将根据蓝图自动分类。
示例
下面是使用sanic openapi的示例:
fromsanicimportSanicfromsanic.responseimportjsonfromsanic_openapiimportswagger_blueprintapp=Sanic()app.blueprint(swagger_blueprint)@app.route("/")asyncdeftest(request):returnjson({"hello":"world"})if__name__=="__main__":app.run(host="0.0.0.0",port=8000)
你可以在http://localhost:8000/swagger找到你的招摇文件,如下所示:
文档
请查看Readthedocs上的文档
贡献
任何贡献都是受欢迎的。如果您不知道如何开始,请先检查问题并检查我们的Contributing Guide以开始您的贡献。