Server Plugin

デフォルトヘッダー

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

Native サーバー

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 を使用して上書きすることはできません。