Package org.springframework.web.client

Interface ApiVersionInserter

All Known Implementing Classes:
DefaultApiVersionInserter
public interface ApiVersionInserter
Contract to determine how to insert an API version into the URI or headers of a request.
Since:
7.0
Author:
Rossen Stoyanchev

  • Method Summary

    Modifier and Type
    Method
    Description
    default URI
    insertVersion(Object version, URI uri)
    Insert the version into the URI.
    default void
    insertVersion(Object version, HttpHeaders headers)
    Insert the version into the request headers.

  • Method Details

    • insertVersion

      default URI insertVersion(Object version, URI uri)
      Insert the version into the URI.

      The default implementation returns the supplied URI unmodified.

      Parameters:
      version - the version to insert
      uri - the URI for the request
      Returns:
      the updated URI, or the original URI unmodified

    • insertVersion

      default void insertVersion(Object version, HttpHeaders headers)
      Insert the version into the request headers.

      The default implementation does not modify the supplied headers.

      Parameters:
      version - the version to insert
      headers - the request headers