使用UI轻松文档化您的Sanic API。
项目描述
⚠️ 此软件包将被 Sanic扩展 替换。项目将继续被监控，但预计不会有新功能或重大开发。如果您正在使用Sanic OpenAPI与OAS3，Sanic扩展将提供近似1:1的升级。有关升级的问题，请在 论坛 或 Discord服务器 上提问。
Sanic OpenAPI
为您的Sanic API提供UI和OpenAPI文档，全部免费！
查看 Open Collective 了解如何帮助资助Sanic。
安装
pip install sanic-openapi
使用 OpenAPI 规范添加 Swagger UI
from sanic_openapi import swagger_blueprint
app.blueprint(swagger_blueprint)
现在您将在 URL /swagger/ 处获得 Swagger UI，以及在 /swagger/swagger.json 处的 OpenAPI 2.0 规范。您的路由将根据其蓝图自动分类。
OpenAPI 2
以下是一个使用 Sanic-OpenAPI 2 的示例
from sanic import Sanic
from sanic.response import json
from sanic_openapi import openapi2_blueprint
app = Sanic(name="AwesomeApi")
app.blueprint(openapi2_blueprint)
@app.route("/")
async def test(request):
return json({"hello": "world"})
if __name__ == "__main__":
app.run(host="0.0.0.0", port=8000)
您可以通过这种方式在 http://localhost:8000/swagger 获取您的 Swagger 文档：
OpenAPI 3
以下是一个使用 Sanic-OpenAPI 3 的示例
from sanic import Sanic
from sanic.response import json
from sanic_openapi import openapi3_blueprint
app = Sanic(name="AwesomeApi")
app.blueprint(openapi3_blueprint)
@app.route("/")
async def test(request):
return json({"hello": "world"})
if __name__ == "__main__":
app.run(host="0.0.0.0", port=8000)
您可以通过这种方式在 http://localhost:8000/swagger 获取您的 Swagger 文档：
文档
请在 Readthedocs 上查看文档
贡献
欢迎任何贡献。如果您不知道如何开始，请先查看问题，并检查我们的 贡献指南 以开始您的贡献。
