diff --git a/spring-web/src/main/java/org/springframework/http/server/reactive/ServerHttpRequest.java b/spring-web/src/main/java/org/springframework/http/server/reactive/ServerHttpRequest.java index 9995cdefad3..592ceb9855e 100644 --- a/spring-web/src/main/java/org/springframework/http/server/reactive/ServerHttpRequest.java +++ b/spring-web/src/main/java/org/springframework/http/server/reactive/ServerHttpRequest.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2020 the original author or authors. + * Copyright 2002-2021 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. @@ -48,9 +48,14 @@ public interface ServerHttpRequest extends HttpRequest, ReactiveHttpInputMessage String getId(); /** - * Returns a structured representation of the request path including the - * context path + path within application portions, path segments with - * encoded and decoded values, and path parameters. + * Returns a structured representation of the full request path up to but + * not including the {@link #getQueryParams() query}. + *

The returned path is sub-divided into a + * {@link RequestPath#contextPath()} portion and the remaining + * {@link RequestPath#pathWithinApplication() pathwithinApplication} portion. + * The latter can be passed into methods of + * {@link org.springframework.web.util.pattern.PathPattern} for path + * matching purposes. */ RequestPath getPath();