Skip to content
Server Plugin

AutoHeadResponse

必要な依存関係: io.ktor:ktor-server-auto-head-response

コード例: autohead

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

AutoHeadResponseプラグインは、GETが定義されているすべてのルートに対してHEADリクエストへ自動的に応答する機能を提供します。実際のコンテンツを取得する前にクライアント側でレスポンスを何らかの形で処理する必要がある場合、AutoHeadResponseを使用すれば個別のheadハンドラーを作成する手間を省くことができます。たとえば、respondFile関数を呼び出すとContent-LengthおよびContent-Typeヘッダーが自動的にレスポンスへ追加されるため、ファイルをダウンロードする前にクライアント側でこれらの情報を取得できます。

依存関係の追加 ​

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

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

使用方法 ​

この機能を利用するには、アプリケーションにAutoHeadResponseプラグインをインストールする必要があります。

kotlin
import io.ktor.server.application.*
import io.ktor.server.plugins.autohead.*
import io.ktor.server.response.*
import io.ktor.server.routing.*

fun Application.main() {
    install(AutoHeadResponse)
    routing {
        get("/home") {
            call.respondText("This is a response to a GET, but HEAD also works")
        }
    }
}

この例では、このHTTPメソッドに対する明示的な定義がないにもかかわらず、/homeルートがHEADリクエストに応答するようになります。

このプラグインを使用している場合、同じGETルートに対するカスタムのHEAD定義は無視されることに注意してください。

オプション ​

AutoHeadResponseには、追加の設定オプションはありません。