HTTPメソッド

自動エンドポイント

デフォルトの動作は、すべてのGETルートにHEADエンドポイントを、そして全ルートにOPTIONSエンドポイントを自動的に生成することです。 さらに、TRACEエンドポイントを自動的に生成するオプションもあります。しかし、これらは初期状態では有効ではありません。

• Configuration: AUTO_HEAD (default True)
• MDN: Read more (opens new window)

HEAD リクエストはヘッダーを提供し、それ以外は GET リクエストが提供するものと同じレスポンスを提供します。 しかし、実際にはボディを返しません。

@app.get("/")
async def hello_world(request):
    return text("Hello, world.")

上記のルート定義があれば、Sanic Extensionsはここで見られるようにHEADレスポンスを有効にします。

$ curl localhost:8000 --head
HTTP/1.1 200 OK
access-control-allow-origin: *
content-length: 13
connection: keep-alive
content-type: text/plain; charset=utf-8

• Configuration: AUTO_OPTIONS (default True)
• MDN: Read more (opens new window)

OPTIONS リクエストは、クライアントが与えられたエンドポイントとの通信をどのように許可されるかの詳細を受信者に提供します。

@app.get("/")
async def hello_world(request):
    return text("Hello, world.")

上記のルート定義があれば、Sanic Extensionsはここで見られるようにHEADレスポンスを有効にします。

この例では、access-control-allow-originsも表示されていることに注意することが重要です。 これは、CORS保護がデフォルトで有効になっているためです。

$ curl localhost:8000 -X OPTIONS -i
HTTP/1.1 204 No Content
allow: GET,HEAD,OPTIONS
access-control-allow-origin: *
connection: keep-alive

Sanic Extensionsがこれらのルートを自動的にセットアップしてくれるとしても、手動で `@app.options` ルートを作成することにした場合、それは オーバーライド**されません**。

• Configuration: AUTO_TRACE (default False)
• MDN: Read more (opens new window)

デフォルトでは、TRACEエンドポイントは自動的に作成されません。しかし、Sanic Extensions では、必要であれば作成することができます。これはバニラSanicでは許可されていないことである。

@app.route("/", methods=["trace"])
async def handler(request):
    ...

これらのエンドポイントの自動作成を有効にするには、まずSanicを拡張する際に有効にする必要があります。

from sanic_ext import Extend, Config
Extend(app, config=Config(auto_trace=True))

さて、いくつかのエンドポイントが設定されていると仮定して、以下のようにトレースすることができます。

$ curl localhost:8000 -X TRACE
TRACE / HTTP/1.1
Host: localhost:9999
User-Agent: curl/7.76.1
Accept: */*

`AUTO_TRACE` を設定すると、特にアプリケーションがプロキシの後ろに配置されている場合、非常に便利です。

は、プロキシがどのように動作しているかを判断するのに役立ちます。

メソッドの追加サポート

バニラSanicでは、以下のHTTPメソッドでエンドポイントを構築することができます。

• GET
• POST
• PUT
• HEAD
• OPTIONS
• PATCH
• DELETE

もっと見たい場合はMDN Web Docs (opens new window) を見てください。

しかし、さらに2つの「標準的な」HTTPメソッドがあります: TRACE と CONNECT です。 Sanic Extensions は、これらのメソッドを使用したエンドポイントの構築を可能にするもので、他の方法では許可されません。

これは便利なメソッドである @app.trace や @app.connect を有効にするものではないことに注意してください。 この例で示されているように、@app.routeを使用する必要があります。

@app.route("/", methods=["trace", "connect"])
async def handler(_):
    return empty()