Skip to content

Commit 6c30d76

Browse files
authored
connection request timeout setting documentation (OpenFeign#1351)
1 parent 6415c3b commit 6c30d76

3 files changed

Lines changed: 12 additions & 7 deletions

File tree

‎README.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,10 @@ with the following alterations:
281281
---
282282
### Customization
283283
284-
Feign has several aspects that can be customized. For simple cases, you can use `Feign.builder()` to construct an API interface with your custom components. For example:
284+
Feign has several aspects that can be customized.
285+
For simple cases, you can use `Feign.builder()` to construct an API interface with your custom components.<br>
286+
For request setting, you can use `options(Request.Options options)` on `target()` to set connectTimeout, connectTimeoutUnit, readTimeout, readTimeoutUnit, followRedirects.<br>
287+
For example:
285288
286289
```java
287290
interface Bank {
@@ -291,8 +294,9 @@ interface Bank {
291294
292295
public class BankService {
293296
public static void main(String[] args) {
294-
Bank bank = Feign.builder().decoder(
295-
new AccountDecoder())
297+
Bank bank = Feign.builder()
298+
.decoder(new AccountDecoder())
299+
.options(new Request.Options(10, TimeUnit.SECONDS, 60, TimeUnit.SECONDS, true))
296300
.target(Bank.class, "https://api.examplebank.com");
297301
}
298302
}

‎example-github/src/main/java/example/github/GitHubExample.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
import java.io.IOException;
1717
import java.util.List;
18+
import java.util.concurrent.TimeUnit;
1819
import java.util.stream.Collectors;
1920
import feign.*;
2021
import feign.codec.Decoder;
@@ -85,6 +86,7 @@ static GitHub connect() {
8586
"Authorization",
8687
"token 383f1c1b474d8f05a21e7964976ab0d403fee071");
8788
})
89+
.options(new Request.Options(10, TimeUnit.SECONDS, 60, TimeUnit.SECONDS, true))
8890
.target(GitHub.class, "https://api.github.com");
8991
}
9092
}

‎example-wikipedia/src/main/java/example/wikipedia/WikipediaExample.java‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,8 @@
2020
import java.io.IOException;
2121
import java.util.ArrayList;
2222
import java.util.Iterator;
23-
import feign.Feign;
24-
import feign.Logger;
25-
import feign.Param;
26-
import feign.RequestLine;
23+
import java.util.concurrent.TimeUnit;
24+
import feign.*;
2725
import feign.gson.GsonDecoder;
2826

2927
public class WikipediaExample {
@@ -61,6 +59,7 @@ public static void main(String... args) throws InterruptedException {
6159
.decoder(new GsonDecoder(gson))
6260
.logger(new Logger.ErrorLogger())
6361
.logLevel(Logger.Level.BASIC)
62+
.options(new Request.Options(10, TimeUnit.SECONDS, 60, TimeUnit.SECONDS, true))
6463
.target(Wikipedia.class, "https://en.wikipedia.org");
6564

6665
System.out.println("Let's search for PTAL!");

0 commit comments

Comments
 (0)