Skip to content
Server Plugin

XHttpMethodOverride

必要な依存関係: io.ktor:ktor-server-method-override

コード例: json-kotlinx-method-override

ネイティブサーバーKtorはKotlin/Nativeをサポートしており、追加のランタイムや仮想マシンなしでサーバーを実行できます。のサポート: ✅

XHttpMethodOverride プラグインは、X-HTTP-Method-Override ヘッダー内で HTTP 動詞をトンネリングする機能を有効にします。 これは、サーバー API が複数の HTTP 動詞(GET、PUT、POST、DELETE など)を処理するものの、クライアント側の特定の制限により使用できる動詞が限られている場合(たとえば GET と POST のみ)に役立ちます。 たとえば、クライアントが X-Http-Method-Override ヘッダーを DELETE に設定してリクエストを送信した場合、Ktor は delete ルートハンドラーを使用してこのリクエストを処理します。

依存関係の追加 ​

XHttpMethodOverride を使用するには、ビルドスクリプトに ktor-server-method-override アーティファクトを追加します。

kotlin
implementation(ktorLibs.server.methodOverride)
上記のコードスニペットでは、Ktor の依存関係を指定するために Ktor バージョンカタログを使用しています。
groovy
implementation ktorLibs.server.methodOverride
上記のコードスニペットでは、Ktor の依存関係を指定するために Ktor バージョンカタログを使用しています。
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-server-method-override-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>

XHttpMethodOverride のインストール ​

XHttpMethodOverride プラグインをアプリケーションにインストールするには、 指定されたモジュールモジュールを使用すると、ルートをグループ化してアプリケーションを構造化できます。内の install 関数に渡します。 次の例は、XHttpMethodOverride をインストールする方法を示しています。

  • embeddedServer() 関数呼び出し内。
  • Application クラスで明示的に定義された module() 拡張関数内。
kotlin
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.plugins.methodoverride.*

fun main() {
    embeddedServer(Netty, port = 8080) {
        install(XHttpMethodOverride)
        // ...
    }.start(wait = true)
}
kotlin
import io.ktor.server.application.*
import io.ktor.server.plugins.methodoverride.*
// ...
fun Application.module() {
    install(XHttpMethodOverride)
    // ...
}

XHttpMethodOverride の設定 ​

デフォルトでは、XHttpMethodOverride は X-Http-Method-Override ヘッダーをチェックして、リクエストを処理すべきルートを決定します。 headerName プロパティを使用してヘッダー名をカスタマイズできます。

例 ​

以下の HTTP リクエストは、X-Http-Method-Override ヘッダーを DELETE に設定した POST 動詞を使用しています。

http
POST http://0.0.0.0:8080/customer/3
X-Http-Method-Override: DELETE

このようなリクエストを delete ルートハンドラーを使用して処理するには、XHttpMethodOverride をインストールする必要があります。

kotlin
package com.example

import io.ktor.http.*
import io.ktor.serialization.kotlinx.json.*
import io.ktor.server.application.*
import io.ktor.server.plugins.contentnegotiation.*
import io.ktor.server.plugins.methodoverride.*
import io.ktor.server.response.*
import io.ktor.server.routing.*
import kotlinx.serialization.*
import kotlinx.serialization.json.*
import io.ktor.server.util.getValue

@Serializable
data class Customer(val id: Int, val firstName: String, val lastName: String)

fun Application.main() {
    val customerStorage = mutableListOf<Customer>()
    customerStorage.addAll(
        arrayOf(
            Customer(1, "Jane", "Smith"),
            Customer(2, "John", "Smith"),
            Customer(3, "Jet", "Brains")
        )
    )

    install(XHttpMethodOverride)
    install(ContentNegotiation) {
        json(Json)
    }
    routing {
        get("/customer/{id}") {
            val id: Int by call.parameters
            val customer: Customer = customerStorage.find { it.id == id }!!
            call.respond(customer)
        }

        delete("/customer/{id}") {
            val id: Int by call.parameters
            customerStorage.removeIf { it.id == id }
            call.respondText("Customer is removed", status = HttpStatusCode.NoContent)
        }
    }
}

完全なサンプルは、こちらにあります: json-kotlinx-method-override。