Skip to content

Commit 1fba430

Browse files
committed
Update HttpExchange Javadoc to mention uses
See gh-32008
1 parent efe85c0 commit 1fba430

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

Diff for: spring-web/src/main/java/org/springframework/web/service/annotation/HttpExchange.java

+12-7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2023 the original author or authors.
2+
* Copyright 2002-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -30,15 +30,20 @@
3030

3131
/**
3232
* Annotation to declare a method on an HTTP service interface as an HTTP
33-
* endpoint. The endpoint details are defined statically through attributes of
33+
* endpoint. Endpoint details are defined statically through attributes of
3434
* the annotation, as well as through the input method argument types.
3535
*
36-
* <p>Supported at the type level to express common attributes, to be inherited
37-
* by all methods, such as a base URL path.
36+
* <p>An HTTP service interface can be passed to
37+
* {@link org.springframework.web.service.invoker.HttpServiceProxyFactory}
38+
* to create a client proxy. It can also be implemented by an
39+
* {@link org.springframework.stereotype.Controller @Controller} for server
40+
* handling. For more details in comparison to {@code @RequestMapping}, see the
41+
* <a href="https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-controller/ann-requestmapping.html#mvc-ann-httpexchange-annotation">reference docs</a>.
3842
*
39-
* <p>At the method level, it's more common to use one of the following HTTP method
40-
* specific, shortcut annotations, each of which is itself <em>meta-annotated</em>
41-
* with {@code HttpExchange}:
43+
* <p>Supported at the type level to express common attributes, to be inherited
44+
* by all methods, such as a base URL path. At the method level, it's more common
45+
* to use one of the following HTTP method specific, shortcut annotations, each
46+
* of which is itself <em>meta-annotated</em> with {@code HttpExchange}:
4247
*
4348
* <ul>
4449
* <li>{@link GetExchange}

0 commit comments

Comments
 (0)