インターフェース ApiVersionStrategy

すべての既知の実装クラス:
DefaultApiVersionStrategy
public interface ApiVersionStrategy
アプリケーションの API バージョン管理を管理するための構成設定と戦略をカプセル化するメインコンポーネント。
導入:
7.0
作成者:
Rossen Stoyanchev, Jonathan Kaplan
関連事項:

  • メソッドの詳細

    • resolveApiVersion

      default Mono<StringSE> resolveApiVersion(ServerWebExchange exchange)
      リクエストからバージョン値を解決します。
      パラメーター:
      exchange - 現在の交換
      戻り値:
      a Mono emitting the raw version as a String, or an empty Mono if no version is found
      導入:
      7.0.3
      関連事項:

    • resolveVersion

      @DeprecatedSE(since="7.0.3", forRemoval=true) @Nullable StringSE resolveVersion(ServerWebExchange exchange)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      7.0.3 現在、resolveApiVersion(ServerWebExchange) を推奨
      リクエストヘッダーなどのリクエストからバージョン値を解決します。
      パラメーター:
      exchange - 現在の交換
      戻り値:
      バージョン（存在する場合）または null
      関連事項:

    • parseVersion

      ComparableSE<?> parseVersion(StringSE version)
      リクエストのバージョンをオブジェクトに解析します。
      パラメーター:
      version - 解析する値
      戻り値:
      バージョンを表すオブジェクト
      関連事項:

    • validateVersion

      void validateVersion(@Nullable ComparableSE<?> requestVersion, ServerWebExchange exchange) throws MissingApiVersionException, InvalidApiVersionException
      必要なバージョンとサポートされているバージョンのチェックを含め、リクエストバージョンを検証します。
      パラメーター:
      requestVersion - 検証するバージョン
      exchange - 交換
      例外:
      MissingApiVersionException - バージョンは必須だが指定されていない場合
      InvalidApiVersionException - バージョンがサポートされていない場合

    • getDefaultVersion

      @Nullable ComparableSE<?> getDefaultVersion()
      指定されていないリクエストに対して使用するデフォルトのバージョンを返します。

    • resolveParseAndValidateApiVersion

      default Mono<ComparableSE<?>> resolveParseAndValidateApiVersion(ServerWebExchange exchange)
      リクエストバージョンを解決、解析、検証する便利なメソッド、構成されている場合はデフォルトのバージョンを返すメソッド。
      パラメーター:
      exchange - 現在の交換
      戻り値:
      a Mono emitting the request version, a validation error, or an empty Mono if there is no version
      導入:
      7.0.3

    • resolveParseAndValidateVersion

      @DeprecatedSE(since="7.0.3", forRemoval=true) default @Nullable ComparableSE<?> resolveParseAndValidateVersion(ServerWebExchange exchange)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      resolveParseAndValidateApiVersion(ServerWebExchange) を推奨
      解析され検証されたリクエストバージョン、または構成されている場合はデフォルトバージョンを返す便利なメソッド。
      パラメーター:
      exchange - 現在の交換
      戻り値:
      解析されたリクエストバージョン、またはデフォルトバージョン

    • handleDeprecations

      void handleDeprecations(ComparableSE<?> version, ObjectSE handler, ServerWebExchange exchange)
      リクエストされた API バージョンが非推奨かどうかを確認し、非推奨の場合はそれに応じて処理します。たとえば、非推奨を通知するレスポンスヘッダーを設定したり、関連する日付を指定したり、詳細へのリンクを提供したりします。
      パラメーター:
      version - 解決され解析されたリクエストバージョン
      handler - 交換のために選ばれたハンドラー
      exchange - 現在の交換
      関連事項: