導入

HTTP メソッド オーバーライドは、PUT や DELETE などの特定の HTTP メソッドをサポートしないクライアントをサポートするために使用される技術です。これは、GET メソッドと POST メソッドのみをサポートする Web ブラウザーと古いクライアントに特に役立ちます。 Iris Web フレームワークは、開発者がアプリケーションに HTTP メソッド オーバーライドを簡単に実装できるようにする、堅牢で柔軟なメソッド オーバーライド ミドルウェアを提供します。このガイドでは、Iris メソッド オーバーライド ミドルウェアの機能と使用法について説明し、その機能を理解して活用して Web アプリケーションを強化するのに役立ちます。

Irisメソッドオーバーライドミドルウェアの特徴

Iris メソッド オーバーライド ミドルウェアは、HTTP メソッド オーバーライドを効率的に処理するためのさまざまな機能を提供します。これらの機能には次のものが含まれます:

1. カスタマイズ可能なメソッド: オーバーライドできる HTTP メソッドを定義します。
2. カスタム ヘッダー: メソッドのオーバーライドを決定するカスタム ヘッダーを指定します。
3. フォーム フィールドのサポート: フォーム フィールドを使用してメソッドのオーバーライドを指定します。
4. クエリ パラメータのサポート: クエリ パラメータを使用してメソッドのオーバーライドを指定します。
5. 元のメソッドを保存: 必要に応じて、後で使用するために元の HTTP メソッドを保存します。

インストール

Iris メソッド オーバーライド ミドルウェアを使用するには、それを Iris アプリケーションにインポートする必要があります:

import "github.com/kataras/iris/v12/middleware/methodoverride"

使用法

基本的なセットアップ

メソッド オーバーライド ミドルウェアを使用するには、必要なパッケージをインポートし、Iris アプリケーションでミドルウェアを構成する必要があります。基本的な例を次に示します:

package main

import (
    "github.com/kataras/iris/v12"
    "github.com/kataras/iris/v12/middleware/methodoverride"
)

func main() {
    app := iris.New()

    // Create the method override middleware
    mo := methodoverride.New(
        methodoverride.SaveOriginalMethod("_originalMethod"),
    )

    // Register the middleware with UseRouter
    app.UseRouter(mo)

    app.Post("/path", func(ctx iris.Context) {
        ctx.WriteString("POST response")
    })

    app.Delete("/path", func(ctx iris.Context) {
        ctx.WriteString("DELETE response")
    })

    app.Listen(":8080")
}

カスタマイズ可能なメソッド

[メソッド] オプションを使用して、どの HTTP メソッドをオーバーライドできるかを定義できます。デフォルトでは、POST メソッドのみをオーバーライドできます。以下に例を示します:

mo := methodoverride.New(
    methodoverride.Methods("POST", "PUT"),
)

カスタムヘッダー

ヘッダー オプションを使用してカスタム ヘッダーを指定し、メソッドのオーバーライドを決定できます。デフォルトでは、ミドルウェアは X-HTTP-Method、X-HTTP-Method-Override、および X-Method-Override ヘッダーをチェックします。以下に例を示します:

mo := methodoverride.New(
    methodoverride.Headers("X-Custom-Method"),
)

フォームフィールドのサポート

フォーム フィールドを使用して、FormField オプションを使用してメソッドのオーバーライドを指定できます。デフォルトでは、ミドルウェアは _method フォーム フィールドをチェックします。以下に例を示します:

mo := methodoverride.New(
    methodoverride.FormField("_method"),
)

クエリパラメータのサポート

クエリ パラメータを使用して、クエリ オプションを使用してメソッドのオーバーライドを指定できます。デフォルトでは、ミドルウェアは _method クエリ パラメーターをチェックします。以下に例を示します:

mo := methodoverride.New(
    methodoverride.Query("_method"),
)

元のメソッドを保存

必要に応じて、SaveOriginalMethod オプションを使用して、後で使用できるように元の HTTP メソッドを保存できます。以下に例を示します:

mo := methodoverride.New(
    methodoverride.SaveOriginalMethod("_originalMethod"),
)

例

これは、Iris アプリケーションでメソッド オーバーライド ミドルウェアを使用する方法を示す完全な例です:

package main

import (
    "github.com/kataras/iris/v12"
    "github.com/kataras/iris/v12/middleware/methodoverride"
)

func main() {
    app := iris.New()

    // Create the method override middleware
    mo := methodoverride.New(
        methodoverride.SaveOriginalMethod("_originalMethod"),
    )

    // Register the middleware with UseRouter
    app.UseRouter(mo)

    app.Post("/path", func(ctx iris.Context) {
        ctx.WriteString("POST response")
    })

    app.Delete("/path", func(ctx iris.Context) {
        ctx.WriteString("DELETE response")
    })

    app.Listen(":8080")
}

結論

Iris メソッド オーバーライド ミドルウェアは、特定の HTTP メソッドをサポートしないクライアントをサポートするためのシンプルかつ効率的な方法を提供します。このミドルウェアの機能を活用することで、Web アプリケーションの互換性と柔軟性を強化できます。