クラス ApiVersionConfigurer

メソッドの詳細

• useRequestHeader

  public ApiVersionConfigurer useRequestHeader(StringSE headerName)

  リクエストヘッダーから API バージョンを抽出するリゾルバーを追加します。

  パラメーター:

  headerName - チェックするヘッダー名

• useQueryParam

  public ApiVersionConfigurer useQueryParam(StringSE paramName)

  クエリ文字列パラメーターから API バージョンを抽出するリゾルバーを追加します。

  パラメーター:

  paramName - チェックするパラメーター名

• useMediaTypeParameter

  public ApiVersionConfigurer useMediaTypeParameter(MediaType compatibleMediaType, StringSE paramName)

  Accept または Content-Type ヘッダーにあるメディア型 パラメーターからバージョンを抽出するためのリゾルバーを追加します。

  パラメーター:

  compatibleMediaType - MediaType.isCompatibleWith(MediaType) を介して一致が確立されたパラメーターを抽出するメディア型

  paramName - パラメーターの名前

• usePathSegment

  public ApiVersionConfigurer usePathSegment(int index)

  パスセグメントから API バージョンを抽出するリゾルバーを追加します。

  このリゾルバーは null を返さないため、他のリゾルバーに譲ることはできないことに注意してください ( PathApiVersionResolver を参照)。

  パラメーター:

  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 を発生させる前に、チェックするサポートされているバージョンのリストに追加します。

  デフォルトでは、リクエストマッピングに表示される実際のバージョン値が検証に使用されます。このメソッドの使用は任意です。ただし、明示的に設定されたサポートされているバージョンのみを使用する場合は、detectSupportedVersions を false に設定してください。

  初期 API バージョンがリクエストマッピングで明示的に宣言されていない場合は、代わりにサポートされているバージョンとしてここで宣言する必要がある場合があることに注意してください。

  パラメーター:

  versions - 追加するサポートされているバージョン値

• detectSupportedVersions

  public ApiVersionConfigurer detectSupportedVersions(boolean detect)

  サポートされているバージョンの検証にマッピングからのバージョンを使用するかどうか。

  デフォルトでは true に設定されており、マッピングされたバージョンはサポートされているバージョンとみなされます。明示的に設定された supported versions のみを使用する場合は、false に設定してください。

  パラメーター:

  detect - 検出されたバージョンを検証に使用するかどうか

• setSupportedVersionPredicate

  public void setSupportedVersionPredicate(@Nullable PredicateSE<ComparableSE<?>> predicate)

  サポートされているバージョンチェックを実行するために PredicateSE を提供します。これは、サポートされているバージョンチェックを事実上引き継ぎ、addSupportedVersions(String...) と detectSupportedVersions に取って代わります。

  パラメーター:

  predicate - 使用する述語

• setDeprecationHandler

  public ApiVersionConfigurer setDeprecationHandler(ApiVersionDeprecationHandler handler)

  非推奨となりた API バージョンへのリクエストを処理するハンドラーを設定します。通常、レスポンスヘッダーに廃止に関するヒントや情報を含めて送信します。

  パラメーター:

  handler - 使用するハンドラー

  関連事項:

  • StandardApiVersionDeprecationHandler

• getApiVersionStrategy

  protected @Nullable ApiVersionStrategy getApiVersionStrategy()