From 1fba430dfc873fd1bfac9286abee590a9257d46a Mon Sep 17 00:00:00 2001 From: rstoyanchev Date: Thu, 18 Jan 2024 18:35:28 +0000 Subject: [PATCH] Update HttpExchange Javadoc to mention uses See gh-32008 --- .../web/service/annotation/HttpExchange.java | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/spring-web/src/main/java/org/springframework/web/service/annotation/HttpExchange.java b/spring-web/src/main/java/org/springframework/web/service/annotation/HttpExchange.java index 0c648d3198e..4f3845ae095 100644 --- a/spring-web/src/main/java/org/springframework/web/service/annotation/HttpExchange.java +++ b/spring-web/src/main/java/org/springframework/web/service/annotation/HttpExchange.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2023 the original author or authors. + * Copyright 2002-2024 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. @@ -30,15 +30,20 @@ import org.springframework.web.util.UriBuilderFactory; /** * Annotation to declare a method on an HTTP service interface as an HTTP - * endpoint. The endpoint details are defined statically through attributes of + * endpoint. Endpoint details are defined statically through attributes of * the annotation, as well as through the input method argument types. * - *

Supported at the type level to express common attributes, to be inherited - * by all methods, such as a base URL path. + *

An HTTP service interface can be passed to + * {@link org.springframework.web.service.invoker.HttpServiceProxyFactory} + * to create a client proxy. It can also be implemented by an + * {@link org.springframework.stereotype.Controller @Controller} for server + * handling. For more details in comparison to {@code @RequestMapping}, see the + * reference docs. * - *

At the method level, it's more common to use one of the following HTTP method - * specific, shortcut annotations, each of which is itself meta-annotated - * with {@code HttpExchange}: + *

Supported at the type level to express common attributes, to be inherited + * by all methods, such as a base URL path. At the method level, it's more common + * to use one of the following HTTP method specific, shortcut annotations, each + * of which is itself meta-annotated with {@code HttpExchange}: * *