# スタートアップ

Sanic Extensionsは、SCOが開発し、保守している公式サポートのプラグインです。このプロジェクトの主な目的は、Web API と Web アプリケーションの開発を容易にするための追加機能を提供することです。

# 機能

自動でHEAD、OPTIONS、TRACEエンドポイントを作成
CORSによる保護
あらかじめ定義されたエンドポイント固有のレスポンスシリアライザー
ルートハンドラへの引数挿入
RedocやSwaggerを使ったOpenAPIドキュメンテーション
リクエストのクエリ引数とボディ入力のバリデーション

# 最低要件

Python: 3.8+
Sanic: 21.9+

# インストール

一番良い方法は、Sanic本体と一緒にSanic Extensionsをインストールするだけです。

pip install sanic[ext]

もちろん、単体でインストールすることも可能です。

pip install sanic-ext

# アプリケーションを拡張

Sanic Extensionsは、特別な操作なしに、たくさんの機能を有効にしてくれます。

NEW in v21.12

Sanic Extensions (v21.12+) をセットアップするために必要なこと: 何もない。環境にインストールされていれば、セットアップが完了し、すぐに使えるようになっています。

このコードは、Sanic Getting Started page にある 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 Getting Started page](../../guide/getting-started.md) の Hello, world アプリを見返してみると、ここで追加されているのはハイライトした2行だけであることがわかると思います。

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.")

どのように設定されているかに関わらず、これでOpenAPIのドキュメントを閲覧し、機能の一部を確認することができるはずです。http://localhost:8000/docs (opens new window)

← How to... HTTPメソッド →