インターフェース ApiVersionInserter

public interface ApiVersionInserter
リクエストの URI またはヘッダーに API バージョンを挿入するための契約。

このインターフェースのショートカットの静的ファクトリメソッドを使用して、組み込みの挿入型実装の 1 つを作成します。

ApiVersionFormatter も構成する場合など、追加のオプションについては builder() を使用します。

導入:
7.0
作成者:
Rossen Stoyanchev

  • メソッドの詳細

    • insertVersion

      default URISE insertVersion(ObjectSE version, URISE uri)
      URI にバージョンを挿入します。

      デフォルトの実装では、指定された URI を変更せずに返します。

      パラメーター:
      version - 挿入するバージョン
      uri - リクエストの URI
      戻り値:
      更新された URI、または変更されていない元の URI

    • insertVersion

      default void insertVersion(ObjectSE version, HttpHeaders headers)
      リクエストヘッダーにバージョンを挿入します。

      デフォルトの実装では、提供されたヘッダーは変更されません。

      パラメーター:
      version - 挿入するバージョン
      headers - リクエストヘッダー

    • useHeader

      static ApiVersionInserter useHeader(@Nullable StringSE header)
      ヘッダーを設定するインサーターを作成します。
      パラメーター:
      header - バージョンを保持するヘッダーの名前

    • useQueryParam

      static ApiVersionInserter useQueryParam(@Nullable StringSE queryParam)
      クエリパラメーターを設定するインサーターを作成します。
      パラメーター:
      queryParam - バージョンを保持するクエリパラメーターの名前

    • useMediaTypeParam

      static ApiVersionInserter useMediaTypeParam(@Nullable StringSE mediaTypeParam)
      "Content-Type" ヘッダーに MediaType パラメーターを設定するためのインサータを作成します。
      パラメーター:
      mediaTypeParam - バージョンを保持するメディア型パラメーターの名前

    • usePathSegment

      static ApiVersionInserter usePathSegment(@Nullable IntegerSE pathSegmentIndex)
      パスセグメントを挿入するインサーターを作成します。
      パラメーター:
      pathSegmentIndex - バージョンを保持するパスセグメントのインデックス

    • builder

      static ApiVersionInserter.Builder builder()
      ApiVersionInserter のビルダーを作成します。