forked from OpenFeign/feign
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathRequestLine.java
More file actions
79 lines (74 loc) · 2.22 KB
/
RequestLine.java
File metadata and controls
79 lines (74 loc) · 2.22 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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/**
* Copyright 2012-2018 The Feign Authors
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package feign;
import java.lang.annotation.Retention;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Expands the request-line supplied in the {@code value}, permitting path and query variables, or
* just the http method. <br>
*
* <pre>
* ...
* @RequestLine("POST /servers")
* ...
*
* @RequestLine("GET /servers/{serverId}?count={count}")
* void get(@Param("serverId") String serverId, @Param("count") int count);
* ...
*
* @RequestLine("GET")
* Response getNext(URI nextLink);
* ...
* </pre>
*
* HTTP version suffix is optional, but permitted. There are no guarantees this version will impact
* that sent by the client. <br>
*
* <pre>
* @RequestLine("POST /servers HTTP/1.1")
* ...
* </pre>
*
* <br>
* <strong>Note:</strong> Query params do not overwrite each other. All queries 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("GET /servers/{serverId}?count={count}")
* void get(@Param("serverId") String serverId, @Param("count") int count);
* ...
* </pre>
*
* <br>
* JAX-RS:
*
* <pre>
* @GET @Path("/servers/{serverId}")
* void get(@PathParam("serverId") String serverId, @QueryParam("count") int count);
* ...
* </pre>
*/
@java.lang.annotation.Target(METHOD)
@Retention(RUNTIME)
public @interface RequestLine {
String value();
boolean decodeSlash() default true;
CollectionFormat collectionFormat() default CollectionFormat.EXPLODED;
}