# 快速开始(Getting Started)

Sanic Extensions 是一个由 SCO 官方开发和维护的 插件。这个项目的主要目标是为 Sanic 添加额外的功能,以帮助开发人员更轻松地进行网络应用程序开发。

# 特征(Features)

  • 能够自动创建 HEADOPTIONS,和 TRACE 响应程序
  • 具有跨域保护
  • 具有内置于指定响应程序的响应序列化器
  • 允许进行路由参数的注入
  • 完美适配 Redoc 和 Swagger
  • 能够对请求参数和请求体进行验证

# 最低要求(Minimum requirements)

  • Python: 3.8+
  • Sanic: 21.9+

# 安装(Install)

最好的安装方式就是在安装 Sanic 的同时一并安装 Sanic 拓展:

pip install sanic[ext]

当然,您也可以独立安装 Sanic 拓展:

pip install sanic-ext

# 拓展您的应用程序(Extend your application)

开箱即用,Sanic 扩展将为您启用一系列功能。

v21.12 新特性

如果您安装了 Sanic 拓展(v21.12+),您不需要做任何初始化设置,它已经是配置好的状态,随时都可使用。

下面这段代码和 Sanic 快速开始页面 中的 Hello,World 示例完全一致,没有做任何改动。

from sanic import Sanic
from sanic.response import text
app = Sanic("MyHelloWorldApp")
@app.get("/")
async def hello_world(request):
    return text("Hello, world.")

已弃用的旧配置

在 v21.9 中,最简单的使用方法就是通过 Extend 来对其进行一个实例化。

如果您回看 Sanic 快速开始 页面 中的 Hello,world 示例代码,您将看它们之间唯一的区别是多了两行高亮部分的代码。



 


 





from sanic import Sanic
from sanic.response import text
from sanic_ext import Extend
app = Sanic("MyHelloWorldApp")
Extend(app)
@app.get("/")
async def hello_world(request):
    return text("Hello, world.")

不管它是如何设置的,您现在应该能够通过 http://localhost:8000/docs (opens new window) 看到 OpenAPI 文档,并能够看到一些正在运行的功能。

MIT Licensed
Copyright © 2018-present Sanic Community Organization

~ Made with ❤️ and ☕️ ~