使用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 cassandra对象映射注释   java定制Solr TokenFilter lemmatizer   字符串从Java文件中读取windows文件名   java如何在Windows上设置StanfordCorenlp服务器以返回文本   java axis2“意外的子元素值”   java使用POI HSSF获取错误   多线程Java等待计时器线程完成   java ForkJoinPool BuffereImage处理风格   从java代码运行Python脚本   java将字节[]转换为短[],使每个短元素包含13位数据   java如何为swing jframe应用程序将代码划分为类   java使用okhttp更改baseurl   java AlertDialog。建设者setView导致堆栈溢出错误   java如何在特定的radius 安卓 studio中接收地址列表?