root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Update HttpExchange Javadoc to mention uses 

See gh-32008
This commit is contained in:
rstoyanchev 2024-01-18 18:35:28 +00:00
parent efe85c0d70
commit 1fba430dfc
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
spring-web/src/main/java/org/springframework/web/service/annotation/HttpExchange.java
View File

@ -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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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 * 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. * the annotation, as well as through the input method argument types.
* *
* <p>Supported at the type level to express common attributes, to be inherited * <p>An HTTP service interface can be passed to
* by all methods, such as a base URL path. * {@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
* <a href="https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-controller/ann-requestmapping.html#mvc-ann-httpexchange-annotation">reference docs</a>.
* *
* <p>At the method level, it's more common to use one of the following HTTP method * <p>Supported at the type level to express common attributes, to be inherited
* specific, shortcut annotations, each of which is itself <em>meta-annotated</em> * by all methods, such as a base URL path. At the method level, it's more common
* with {@code HttpExchange}: * to use one of the following HTTP method specific, shortcut annotations, each
* of which is itself <em>meta-annotated</em> with {@code HttpExchange}:
* *
* <ul> * <ul>
* <li>{@link GetExchange} * <li>{@link GetExchange}