インターフェース ApiVersionStrategy

メソッドの詳細

• resolveVersion

  @Nullable StringSE resolveVersion(ServerWebExchange exchange)

  リクエストヘッダーなどのリクエストからバージョン値を解決します。

  パラメーター:

  exchange - 現在の交換

  戻り値:

  バージョン（存在する場合）または null

  関連事項:

  • ApiVersionResolver

• parseVersion

  ComparableSE<?> parseVersion(StringSE version)

  リクエストのバージョンをオブジェクトに解析します。

  パラメーター:

  version - 解析する値

  戻り値:

  バージョンを表すオブジェクト

  関連事項:

  • ApiVersionParser

• validateVersion

  void validateVersion(@Nullable ComparableSE<?> requestVersion, ServerWebExchange exchange) throws MissingApiVersionException, InvalidApiVersionException

  必要なバージョンとサポートされているバージョンのチェックを含め、リクエストバージョンを検証します。

  パラメーター:

  requestVersion - 検証するバージョン

  exchange - 交換

  例外:

  MissingApiVersionException - バージョンは必須だが指定されていない場合

  InvalidApiVersionException - バージョンがサポートされていない場合

• getDefaultVersion

  @Nullable ComparableSE<?> getDefaultVersion()

  指定されていないリクエストに対して使用するデフォルトのバージョンを返します。

• resolveParseAndValidateVersion

  default @Nullable ComparableSE<?> resolveParseAndValidateVersion(ServerWebExchange exchange)

  解析され検証されたリクエストバージョン、または構成されている場合はデフォルトバージョンを返す便利なメソッド。

  パラメーター:

  exchange - 現在の交換

  戻り値:

  解析されたリクエストバージョン、またはデフォルトバージョン

• handleDeprecations

  void handleDeprecations(ComparableSE<?> version, ServerWebExchange exchange)

  リクエストされた API バージョンが非推奨かどうかを確認し、非推奨の場合はそれに応じて処理します。たとえば、非推奨を通知するレスポンスヘッダーを設定したり、関連する日付を指定したり、詳細へのリンクを提供したりします。

  パラメーター:

  version - 解決され解析されたリクエストバージョン

  exchange - 現在の交換

  関連事項:

  • ApiVersionDeprecationHandler