Skip to content

Commit f288e79

Browse files
committed
Improve compression documentation. Fixes gh-1056.
1 parent 2755880 commit f288e79

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/modules/ROOT/pages/spring-cloud-openfeign.adoc

+3
Original file line numberDiff line numberDiff line change
@@ -587,6 +587,9 @@ spring.cloud.openfeign.compression.request.min-request-size=2048
587587

588588
These properties allow you to be selective about the compressed media types and minimum request threshold length.
589589

590+
When the request matches the mime type set in `spring.cloud.openfeign.compression.request.mime-types` and the size set in `spring.cloud.openfeign.compression.request.min-request-size`, `spring.cloud.openfeign.compression.request.enabled=true` results in compression headers being added to the request.
591+
The functionality of the headers is to signal to the server that a compressed body is expected by the client. It is the responsibility of the server-side app to provide the compressed body based on the headers provided by the client.
592+
590593
TIP: Since the OkHttpClient uses "transparent" compression, that is disabled if the `content-encoding` or `accept-encoding` header is present, we do not enable compression when `feign.okhttp.OkHttpClient` is present on the classpath and `spring.cloud.openfeign.okhttp.enabled` is set to `true`.
591594

592595
[[feign-logging]]

0 commit comments

Comments
 (0)