+1
Daily
9,799
stars
1,954
forks
390
watchers
2,565
prs
1,103
issues
57
releases
README
Feign simplifies the process of writing Java HTTP clients Feign is a Java to HTTP client binder inspired by Retrofit, JAXRS-2.0, and WebSocket. Feign's first goal was reducing the complexity of binding Denominator uniformly to HTTP APIs regardless of ReSTfulness. --- Why Feign and not X? Feign uses tools like Jersey and CXF to write Java clients for ReST or SOAP services. Furthermore, Feign allows you to write your own code on top of http libraries such as Apache HC. Feign connects your code to http APIs with minimal overhead and code via customizable decoders and error handling, which can be written to any text-based http API. How does Feign work? Feign works by processing annotations into a templatized request. Arguments are applied to these templates in a straightforward fashion before output. Although Feign is limited to supporting text-based APIs, it dramatically simplifies system aspects such as replaying requests. Furthermore, Feign makes it easy to unit test your conversions knowing this. Java Version Compatibility Feign 10.x and above are built on Java 8 and should work on Java 9, 10, and 11. For those that need JDK 6 compatibility, please use Feign 9.x Feature overview This is a map with current key features provided by feign: !MindMap overview Roadmap Feign 11 and beyond Making _API_ clients easier Short Term - What we're working on now. ⏰ --- Response Caching Support caching of api responses. Allow for users to define under what conditions a response is eligible for caching and what type of caching mechanism should be used. Support in-memory caching and external cache implementations (EhCache, Google, Spring, etc...) Complete URI Template expression support Support level 1 through level 4 URI template expressions. Use URI Templates TCK to verify compliance. Logger API refactor Refactor the Logger API to adhere closer to frameworks like SLF4J providing a common mental model for logging within Feign. This model will be used by Feign itself throughout and provide clearer direction on how the Logger will be used. Retry API refactor Refactor the Retry API to support user-supplied conditions and better control over back-off policies. This may result in non-backward-compatible breaking changes Medium Term - What's up next. ⏲ --- Async execution support via CompletableFuture Allow for Future chaining and executor management for the request/response lifecycle. Implementation will require non-backward-compatible breaking changes. However this feature is required before Reactive execution can be considered. Reactive execution support via Reactive Streams For JDK 9+, consider a native implementation that uses java.util.concurrent.Flow. Support for Project Reactor and RxJava 2+ implementations on JDK 8. Long Term - The future ☁️ --- Additional Circuit Breaker Support. Support additional Circuit Breaker implementations like Resilience4J and Spring Circuit Breaker --- Usage The
Top issues
#361Non-blocking I/O support60 comments · 2016-03-16#2734Add support for streaming on requests (and add better handling for streaming in responses)51 comments · 2025-01-18#214Better support for request-specific headers40 comments · 2015-03-30#1448Add support for encoders even when no or multiple body parameters are present39 comments · 2021-06-30#249Allow for 3xx range headers28 comments · 2015-07-12#774OpenFeign Compatibility with Android SDK < 2622 comments · 2018-08-17#220Support streaming uploads20 comments · 2015-04-13#521Support Conditional Parameter Expansion19 comments · 2017-01-19
Latest release
OpenFeign 13.18 13.18 2026-11-10What's Changed Add feign-jdk-json codec for the JDK Simple JSON API (JEP 540) and fix Dependabot auto-merge by @velo in https://github.com/OpenFeign/feign/pull/3620 Exclude static fields from field query maps by @hutiefang76 in https://github.com/OpenFeign/feign/pull/3613 Treat runtime HeaderMap values as literals by @hutiefang76 in https://github.com/OpenFeign/feign/pull/3612 docs: fix typos in documentation by @hamidzr in https://github.com/OpenFeign/feign/pull/3659 Reads response charset after other Content-Type parameters by @hutiefang76 in https://github.com/OpenFeign/feign/pull/3628