クラス ApiVersionConfigurer

java.lang.ObjectSE
org.springframework.web.servlet.config.annotation.ApiVersionConfigurer
public class ApiVersionConfigurer extends ObjectSE
API のバージョン管理を構成します。
導入:
7.0
作成者:
Rossen Stoyanchev

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

    • ApiVersionConfigurer

      public ApiVersionConfigurer()

  • メソッドの詳細

    • useRequestHeader

      public ApiVersionConfigurer useRequestHeader(StringSE headerName)
      リクエストヘッダーから API バージョンを抽出するリゾルバーを追加します。
      パラメーター:
      headerName - チェックするヘッダー名

    • useRequestParam

      public ApiVersionConfigurer useRequestParam(StringSE paramName)
      リクエストパラメーターから API バージョンを抽出するリゾルバーを追加します。
      パラメーター:
      paramName - チェックするパラメーター名

    • usePathSegment

      public ApiVersionConfigurer usePathSegment(int index)
      パスセグメントから API バージョンを抽出するリゾルバーを追加します。
      パラメーター:
      index - チェックするパスセグメントのインデックス。たとえば、"/{version}/..." のような URL の場合はインデックス 0 を使用し、"/api/{version}/..." の場合はインデックス 1 を使用します。

    • useVersionResolver

      public ApiVersionConfigurer useVersionResolver(ApiVersionResolver... resolvers)
      API バージョンを解決するためにカスタムリゾルバーを追加します。
      パラメーター:
      resolvers - 使用するリゾルバー

    • setVersionParser

      public ApiVersionConfigurer setVersionParser(@Nullable ApiVersionParser<?> versionParser)
      API バージョンを解析するためのパーサーを構成します。

      デフォルトでは、SemanticApiVersionParser が使用されます。

      パラメーター:
      versionParser - パーサーからユーザーへ

    • setVersionRequired

      public ApiVersionConfigurer setVersionRequired(boolean required)
      リクエストに API バージョンの指定が必須かどうか。true に設定すると、リクエストに API バージョンが指定されていない場合は MissingApiVersionException が発生し、400 レスポンスが返されます。false に設定すると、バージョンが指定されていないリクエストはどのバージョンでも受け付けられるとみなされます。

      デフォルトでは、少なくとも 1 つの ApiVersionResolver を追加して API バージョン管理が有効になっている場合、これは true に設定されます。defaultVersion も設定されている場合、これは自動的に false に設定されます。

      パラメーター:
      required - API バージョンが必要かどうか。

    • setDefaultVersion

      public ApiVersionConfigurer setDefaultVersion(@Nullable StringSE defaultVersion)
      指定されていないリクエストに割り当てるデフォルトのバージョンを構成します。
      パラメーター:
      defaultVersion - 使用するデフォルトのバージョン

    • addSupportedVersions

      public ApiVersionConfigurer addSupportedVersions(StringSE... versions)
      リクエストバージョンを検証するためのサポート対象バージョンリストに追加します。サポートされていないリクエストバージョンの場合は、InvalidApiVersionException が返されます。

      サポートされるバージョンセットは、コントローラーマッピングにリストされているバージョンから生成されることに注意してください。そのため、コントローラーが起動時に特定のバージョンを必要としない場合、初期 API バージョンを除き、通常はこのリストを管理する必要はありません。

      パラメーター:
      versions - supported versions to add

    • getApiVersionStrategy

      protected @Nullable ApiVersionStrategy getApiVersionStrategy()