インターフェース ApiVersionStrategy

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

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    @Nullable ComparableSE<?>
    getDefaultVersion()
    指定されていないリクエストに対して使用するデフォルトのバージョンを返します。
    void
    handleDeprecations(ComparableSE<?> version, ObjectSE handler, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
    リクエストされた API バージョンが非推奨かどうかを確認し、非推奨の場合はそれに応じて処理します。例:
    ComparableSE<?>
    parseVersion(StringSE version)
    リクエストのバージョンをオブジェクトに解析します。
    default @Nullable ComparableSE<?>
    resolveParseAndValidateVersion(jakarta.servlet.http.HttpServletRequest request)
    解析され検証されたリクエストバージョン、または構成されている場合はデフォルトバージョンを返す便利なメソッド。
    @Nullable StringSE
    resolveVersion(jakarta.servlet.http.HttpServletRequest request)
    リクエストからバージョン値を解決します。例:
    void
    validateVersion(@Nullable ComparableSE<?> requestVersion, jakarta.servlet.http.HttpServletRequest request)
    必要なバージョンとサポートされているバージョンのチェックを含め、リクエストバージョンを検証します。

  • メソッドの詳細

    • resolveVersion

      @Nullable StringSE resolveVersion(jakarta.servlet.http.HttpServletRequest request)
      リクエストヘッダーなどのリクエストからバージョン値を解決します。
      パラメーター:
      request - 現在のリクエスト
      戻り値:
      バージョン（存在する場合）または null
      関連事項:

    • parseVersion

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

    • validateVersion

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

    • getDefaultVersion

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

    • resolveParseAndValidateVersion

      default @Nullable ComparableSE<?> resolveParseAndValidateVersion(jakarta.servlet.http.HttpServletRequest request)
      解析され検証されたリクエストバージョン、または構成されている場合はデフォルトバージョンを返す便利なメソッド。
      パラメーター:
      request - 現在のリクエスト
      戻り値:
      解析されたリクエストバージョン、またはデフォルトバージョン

    • handleDeprecations

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