Server Plugin

デフォルトヘッダー

必須の依存関係: io.ktor:ktor-server-default-headers

ネイティブサーバー

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

のサポート: ✅

DefaultHeadersプラグインは、標準のServerおよびDateヘッダーを各レスポンスに追加します。さらに、追加のデフォルトヘッダーを提供したり、Serverヘッダーをオーバーライドしたりできます。

依存関係を追加する

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

Gradle (Kotlin)Gradle (Groovy)Maven

DefaultHeadersをインストールする

アプリケーションにDefaultHeadersプラグインをインストールするには、 指定された

モジュール

モジュールを使用すると、ルートをグループ化してアプリケーションを構造化できます。

内のinstall関数に渡します。 以下のコードスニペットは、DefaultHeadersをインストールする方法を示しています。

• ... embeddedServer関数呼び出し内で。
• ... 明示的に定義されたmodule (これはApplicationクラスの拡張関数です) 内で。

embeddedServermodule

DefaultHeadersプラグインは、特定のルートにもインストールできます。 これは、異なるアプリケーションリソースに対して異なるDefaultHeaders設定が必要な場合に役立つことがあります。

DefaultHeadersを設定する

追加のヘッダーを追加する

デフォルトヘッダーのリストをカスタマイズするには、header(name, value)関数を使用して、希望するヘッダーをinstallに渡します。nameパラメーターはHttpHeaders値を受け入れます。例:

    install(DefaultHeaders) {
        header(HttpHeaders.ETag, "7c876b7e")
    }

カスタムヘッダーを追加するには、その名前を文字列値として渡します:

    install(DefaultHeaders) {
        header("Custom-Header", "Some value")
    }

ヘッダーをオーバーライドする

Serverヘッダーをオーバーライドするには、対応するHttpHeaders値を使用します:

    install(DefaultHeaders) {
        header(HttpHeaders.Server, "Custom")
    }

Dateヘッダーはパフォーマンス上の理由からキャッシュされ、DefaultHeadersを使用してオーバーライドできないことに注意してください。