forked from OpenFeign/feign
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathHeaders.java
More file actions
50 lines (47 loc) · 1.15 KB
/
Headers.java
File metadata and controls
50 lines (47 loc) · 1.15 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package feign;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Expands headers supplied in the {@code value}. Variables are permitted as values.
* <br>
* <pre>
* @RequestLine("GET /")
* @Headers("Cache-Control: max-age=640000")
* ...
*
* @RequestLine("POST /")
* @Headers({
* "X-Foo: Bar",
* "X-Ping: {token}"
* }) void post(@Named("token") String token);
* ...
* </pre>
* <br>
* <strong>Note:</strong> Headers do not overwrite each other. All headers with the same name will
* be included in the request.
* <br><br><b>Relationship to JAXRS</b><br>
* <br>
* The following two forms are identical.
* <br>
* Feign:
* <pre>
* @RequestLine("POST /")
* @Headers({
* "X-Ping: {token}"
* }) void post(@Named("token") String token);
* ...
* </pre>
* <br>
* JAX-RS:
* <pre>
* @POST @Path("/")
* void post(@HeaderParam("X-Ping") String token);
* ...
* </pre>
*/
@Target(METHOD) @Retention(RUNTIME)
public @interface Headers {
String[] value();
}