diff --git a/README.adoc b/README.adoc index 78003e90..f8f0600d 100644 --- a/README.adoc +++ b/README.adoc @@ -10,6 +10,23 @@ image:https://codecov.io/gh/spring-cloud/spring-cloud-openfeign/branch/master/gr image:https://api.codacy.com/project/badge/Grade/97b04c4e609c4b4f86b415e4437a6484["Codacy code quality", link="https://www.codacy.com/app/Spring-Cloud/spring-cloud-openfeign?utm_source=github.com&utm_medium=referral&utm_content=spring-cloud/spring-cloud-openfeign&utm_campaign=Badge_Grade"] +:doctype: book +:idprefix: +:idseparator: - +:toc: left +:toclevels: 4 +:tabsize: 4 +:numbered: +:sectanchors: +:sectnums: +:icons: font +:hide-uri-scheme: +:docinfo: shared,private + +:sc-ext: java +:project-full-name: Spring Cloud OpenFeign +:all: {asterisk}{asterisk} + This project provides OpenFeign integrations for Spring Boot apps through autoconfiguration and binding to the Spring Environment and other Spring programming model idioms. diff --git a/docs/pom.xml b/docs/pom.xml index 5125edd7..0f1fc746 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -16,7 +16,14 @@ spring-cloud-openfeign ${basedir}/.. 2.0.x,2.1.x + feign.* + + + ${project.groupId} + spring-cloud-starter-openfeign + + @@ -32,6 +39,10 @@ docs + + pl.project13.maven + git-commit-id-plugin + org.apache.maven.plugins maven-dependency-plugin @@ -40,6 +51,10 @@ org.apache.maven.plugins maven-resources-plugin + + org.codehaus.mojo + exec-maven-plugin + org.asciidoctor asciidoctor-maven-plugin diff --git a/docs/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc index 851973db..0121bf75 100644 --- a/docs/src/main/asciidoc/README.adoc +++ b/docs/src/main/asciidoc/README.adoc @@ -4,6 +4,8 @@ image:https://codecov.io/gh/spring-cloud/spring-cloud-openfeign/branch/master/gr image:https://api.codacy.com/project/badge/Grade/97b04c4e609c4b4f86b415e4437a6484["Codacy code quality", link="https://www.codacy.com/app/Spring-Cloud/spring-cloud-openfeign?utm_source=github.com&utm_medium=referral&utm_content=spring-cloud/spring-cloud-openfeign&utm_campaign=Badge_Grade"] +include::_attributes.adoc[] + include::intro.adoc[] == Features diff --git a/docs/src/main/asciidoc/_attributes.adoc b/docs/src/main/asciidoc/_attributes.adoc new file mode 100644 index 00000000..882edab8 --- /dev/null +++ b/docs/src/main/asciidoc/_attributes.adoc @@ -0,0 +1,16 @@ +:doctype: book +:idprefix: +:idseparator: - +:toc: left +:toclevels: 4 +:tabsize: 4 +:numbered: +:sectanchors: +:sectnums: +:icons: font +:hide-uri-scheme: +:docinfo: shared,private + +:sc-ext: java +:project-full-name: Spring Cloud OpenFeign +:all: {asterisk}{asterisk} diff --git a/docs/src/main/asciidoc/_configprops.adoc b/docs/src/main/asciidoc/_configprops.adoc new file mode 100644 index 00000000..67c39490 --- /dev/null +++ b/docs/src/main/asciidoc/_configprops.adoc @@ -0,0 +1,23 @@ +|=== +|Name | Default | Description + +|feign.client.config | | +|feign.client.default-config | default | +|feign.client.default-to-properties | true | +|feign.compression.request.enabled | false | Enables the request sent by Feign to be compressed. +|feign.compression.request.mime-types | [text/xml, application/xml, application/json] | The list of supported mime types. +|feign.compression.request.min-request-size | 2048 | The minimum threshold content size. +|feign.compression.response.enabled | false | Enables the response from Feign to be compressed. +|feign.httpclient.connection-timeout | 2000 | +|feign.httpclient.connection-timer-repeat | 3000 | +|feign.httpclient.disable-ssl-validation | false | +|feign.httpclient.enabled | true | Enables the use of the Apache HTTP Client by Feign. +|feign.httpclient.follow-redirects | true | +|feign.httpclient.max-connections | 200 | +|feign.httpclient.max-connections-per-route | 50 | +|feign.httpclient.time-to-live | 900 | +|feign.httpclient.time-to-live-unit | | +|feign.hystrix.enabled | false | If true, an OpenFeign client will be wrapped with a Hystrix circuit breaker. +|feign.okhttp.enabled | false | Enables the use of the OK HTTP Client by Feign. + +|=== diff --git a/docs/src/main/asciidoc/spring-cloud-openfeign.adoc b/docs/src/main/asciidoc/spring-cloud-openfeign.adoc index 4b2f2965..1a1e2f8b 100644 --- a/docs/src/main/asciidoc/spring-cloud-openfeign.adoc +++ b/docs/src/main/asciidoc/spring-cloud-openfeign.adoc @@ -1,11 +1,5 @@ -:github-tag: master -:github-repo: spring-cloud/spring-cloud-openfeign -:github-raw: https://raw.github.com/{github-repo}/{github-tag} -:github-code: https://github.com/{github-repo}/tree/{github-tag} -:all: {asterisk}{asterisk} -:nofooter: -:branch: master = Spring Cloud OpenFeign +include::_attributes.adoc[] *{spring-cloud-version}* @@ -510,3 +504,7 @@ public interface DemoTemplate { CollectionModel getStores(); } ---- + +== Configuration properties + +To see the list of all Sleuth related configuration properties please check link:appendix.html[the Appendix page].