Enable Section Summary TOC for small pages
This commit is contained in:
sgibb
@@ -2,6 +2,7 @@
|
||||
[appendix]
|
||||
[[common-application-properties]]
|
||||
= Common application properties
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
|
||||
Various properties can be specified inside your `application.properties` file, inside your `application.yml` file, or as command line switches.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[spring-cloud-gateway]]
|
||||
= Spring Cloud Gateway
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
*{spring-cloud-version}*
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[aot-and-native-image-support]]
|
||||
= AOT and Native Image Support
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
Since `4.0.0`, Spring Cloud Gateway supports Spring AOT transformations and native images.
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
[[configuration-properties]]
|
||||
= Configuration properties
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
To see the list of all Spring Cloud Gateway related configuration properties, see link:appendix.html[the appendix].
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[gatewayfilter-factories]]
|
||||
= `GatewayFilter` Factories
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
Route filters allow the modification of the incoming HTTP request or outgoing HTTP response in some manner.
|
||||
Route filters are scoped to a particular route.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[default-filters]]
|
||||
= Default Filters
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
To add a filter and apply it to all routes, you can use `spring.cloud.gateway.default-filters`.
|
||||
This property takes a list of filters.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[the-prefixpath-gatewayfilter-factory]]
|
||||
= The `PrefixPath` `GatewayFilter` Factory
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
The `PrefixPath` `GatewayFilter` factory takes a single `prefix` parameter.
|
||||
The following example configures a `PrefixPath` `GatewayFilter`:
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[the-preservehostheader-gatewayfilter-factory]]
|
||||
= The `PreserveHostHeader` `GatewayFilter` Factory
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
The `PreserveHostHeader` `GatewayFilter` factory has no parameters.
|
||||
This filter sets a request attribute that the routing filter inspects to determine if the original host header should be sent rather than the host header determined by the HTTP client.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[the-removerequestheader-gatewayfilter-factory]]
|
||||
= The `RemoveRequestHeader` GatewayFilter Factory
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
The `RemoveRequestHeader` `GatewayFilter` factory takes a `name` parameter.
|
||||
It is the name of the header to be removed.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[the-removerequestparameter-gatewayfilter-factory]]
|
||||
= The `RemoveRequestParameter` `GatewayFilter` Factory
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
The `RemoveRequestParameter` `GatewayFilter` factory takes a `name` parameter.
|
||||
It is the name of the query parameter to be removed.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[the-requestheadersize-gatewayfilter-factory]]
|
||||
= The `RequestHeaderSize` `GatewayFilter` Factory
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
The `RequestHeaderSize` `GatewayFilter` factory takes `maxSize` and `errorHeaderName` parameters.
|
||||
The `maxSize` parameter is the maximum data size allowed by the request header (including key and value). The `errorHeaderName` parameter sets the name of the response header containing an error message, by default it is "errorMessage".
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[the-rewriteresponseheader-gatewayfilter-factory]]
|
||||
= The `RewriteResponseHeader` `GatewayFilter` Factory
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
The `RewriteResponseHeader` `GatewayFilter` factory takes `name`, `regexp`, and `replacement` parameters.
|
||||
It uses Java regular expressions for a flexible way to rewrite the response header value.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[glossary]]
|
||||
= Glossary
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
* *Route*: The basic building block of the gateway.
|
||||
It is defined by an ID, a destination URI, a collection of predicates, and a collection of filters. A route is matched if the aggregate predicate is true.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[gateway-how-it-works]]
|
||||
= How It Works
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
The following diagram provides a high-level overview of how Spring Cloud Gateway works:
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[gateway-starter]]
|
||||
= How to Include Spring Cloud Gateway
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
To include Spring Cloud Gateway in your project, use the starter with a group ID of `org.springframework.cloud` and an artifact ID of `spring-cloud-starter-gateway`.
|
||||
See the https://projects.spring.io/spring-cloud/[Spring Cloud Project page] for details on setting up your build system with the current Spring Cloud Release Train.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
[[troubleshooting]]
|
||||
= Troubleshooting
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
This section covers common problems that may arise when you use Spring Cloud Gateway.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user