Server Plugin

AutoHeadResponse

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

コード例: autohead

Nativeサーバー

Ktor supports Kotlin/Native and allows you to run a server without an additional runtime or virtual machine.

のサポート: ✅

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

依存関係の追加

AutoHeadResponseを使用するには、ビルドスクリプトにktor-server-auto-head-responseアーティファクトを含める必要があります。

Gradle (Kotlin)Gradle (Groovy)Maven

使用方法

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

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

この例では、/homeルートに対して明示的な定義がなくても、HEADリクエストに応答するようになります。

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

オプション

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