org.springframework.web.accept.ApiVersionResolver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-web Show documentation

Spring Web

The newest version!

/*
 * Copyright 2002-2025 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.web.accept;

import jakarta.servlet.http.HttpServletRequest;
import org.jspecify.annotations.Nullable;

/**
 * Contract to extract the version from a request.
 *
 * @author Rossen Stoyanchev
 * @since 7.0
 */
@FunctionalInterface
public
interface ApiVersionResolver {

	/**
	 * Resolve the version for the given request.
	 * @param request the current request
	 * @return the version value, or {@code null} if not found
	 */
	@Nullable String resolveVersion(HttpServletRequest request);

}