クラス StandardApiVersionDeprecationHandler

java.lang.ObjectSE
org.springframework.web.reactive.accept.StandardApiVersionDeprecationHandler
実装されているすべてのインターフェース:
ApiVersionDeprecationHandler
public class StandardApiVersionDeprecationHandler extends ObjectSE implements ApiVersionDeprecationHandler
ApiVersionDeprecationHandler は RFC 9745 と RFC 8594 に基づいており、"Deprecation" および "Sunset" レスポンスヘッダーを設定するオプションと、両方の詳細を含む "Link" ヘッダーを追加するオプションを提供します。

このハンドラーを使用するには、インスタンスを作成し、非推奨バージョンごとに configureVersion(java.lang.String) を呼び出し、返された StandardApiVersionDeprecationHandler.VersionSpec を使用して非推奨の詳細を提供し、クライアントに送信します。

導入:
7.0
作成者:
Rossen Stoyanchev

  • コンストラクターの詳細

    • StandardApiVersionDeprecationHandler

      public StandardApiVersionDeprecationHandler()
      インスタンスの作成。

      デフォルトでは、設定された API バージョンの解析に SemanticApiVersionParser が使用されるため、実行時に解析されるリクエストバージョンと比較することができます。カスタムパーサーをご利用の場合は、StandardApiVersionDeprecationHandler(ApiVersionParser) コンストラクターを使用してください。

    • StandardApiVersionDeprecationHandler

      public StandardApiVersionDeprecationHandler(ApiVersionParser<?> parser)
      カスタム ApiVersionParser を使用したデフォルトコンストラクターのバリアント。これは、実行時にリクエストバージョンを解析するために使用されるパーサー型と同じである必要があります。

  • メソッドの詳細

    • configureVersion

      public StandardApiVersionDeprecationHandler.VersionSpec configureVersion(StringSE version)
      指定された API バージョンを非推奨としてマークし、返された StandardApiVersionDeprecationHandler.VersionSpec を使用して、クライアントに送信する非推奨の詳細を構成します。
      パラメーター:
      version - 非推奨としてマークするバージョン
      戻り値:
      廃止の詳細を設定する仕様

    • handleVersion

      public void handleVersion(ComparableSE<?> requestVersion, ServerWebExchange exchange)
      インターフェースからコピーされた説明: ApiVersionDeprecationHandler
      リクエストされた API バージョンが非推奨かどうかを確認し、非推奨の場合はそれに応じて処理します。たとえば、非推奨を通知するレスポンスヘッダーを設定したり、関連する日付を指定したり、詳細へのリンクを提供したりします。
      次で指定:
      インターフェース ApiVersionDeprecationHandler の handleVersion 
      パラメーター:
      requestVersion - 解決され解析されたリクエストバージョン
      exchange - 現在の交換

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString