使用ui轻松记录sanic api。

sanic-openapi的Python项目详细描述


Sanic OpenAPI

Build StatusPyPIPyPICode style: blackcodecov

给你的sanic api一个ui和openapi文档,一切都是免费的!

Example Swagger UI

安装

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以开始您的贡献。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java将Map<String,String>传递给需要Map<String,Object>   java在循环中使用字符串而不是StringBuilder是否会造成内存损失?   jnlp如何更新java控制台JRE?   java更改、修改和重新打包CXFAPI源文件   JavaFXJava应用程序在Fedora上运行一段时间后关闭   使用来自不同类的方法的java   java如何通过ant脚本在linux中使用subst?   java在使用camunda modeler进行base64编码/解码时出错   获取java。netbeans、weblogic和fastswap设置为true时的lang.NoSuchMethodError   java如何提高FinalizerThread在GC中收集对象的优先级   java检测具有相同根的单词   netbeans crud应用程序中的java错误