WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit 32e0a3f

Browse files
Layau-codeLayau-code
committed
docs: fix table format in spring-webmvc README files (MD060/MD009)
1 parent abce6b6 commit 32e0a3f

File tree

2 files changed

+34
-15
lines changed
  • sentinel-adapter

2 files changed

+34
-15
lines changed

‎sentinel-adapter/sentinel-spring-webmvc-adapter/README.md‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,23 @@ config.setBlockExceptionHandler((request, response, e) -> {
9191

9292
- Common configuration in `SentinelWebMvcConfig` and `SentinelWebMvcTotalConfig`:
9393

94-
|name|description|type|default value||------|------------|------|-------||`blockExceptionHandler`|The handler that handles the block request|`BlockExceptionHandler`|null (throw out the BlockException)||`originParser`|Extracting request origin (e.g. IP or appName from HTTP Header) from HTTP request|`RequestOriginParser`|-|- `SentinelWebMvcConfig` configuration:|name|description|type|default value||------|------------|------|-------||urlCleaner|The `UrlCleaner` interface is designed for clean and unify the URL resource.|`UrlCleaner`|-||requestAttributeName|Attribute key in request used by Sentinel (internal)|`String`|`$$sentinel_spring_web_entry_attr`||httpMethodSpecify|Specify whether the URL resource name should contain the HTTP method prefix (e.g. `POST:`).|`boolean`|`false`||webContextUnify|Specify whether unify web context(i.e. use the default context name).|`boolean`|`true`|- `SentinelWebMvcTotalConfig` configuration:|name|description|type|default value||------|------------|------|-------||totalResourceName|The resource name in `SentinelTotalInterceptor`|`String`|`spring-mvc-total-url-request`||requestAttributeName|Attribute key in request used by Sentinel (internal)|`String`|`$$sentinel_spring_web_total_entry_attr`|
94+
| name | description | type | default value |
95+
| ------ | ------------ | ------ | ------- |
96+
| `blockExceptionHandler` | The handler that handles the block request | `BlockExceptionHandler` | null (throw out the BlockException) |
97+
| `originParser` | Extracting request origin (e.g. IP or appName from HTTP Header) from HTTP request | `RequestOriginParser` | - |
98+
99+
- `SentinelWebMvcConfig` configuration:
100+
101+
| name | description | type | default value |
102+
| ------ | ------------ | ------ | ------- |
103+
| urlCleaner | The `UrlCleaner` interface is designed for clean and unify the URL resource. | `UrlCleaner` | - |
104+
| requestAttributeName | Attribute key in request used by Sentinel (internal) | `String` | `$$sentinel_spring_web_entry_attr` |
105+
| httpMethodSpecify | Specify whether the URL resource name should contain the HTTP method prefix (e.g. `POST:`). | `boolean` | `false` |
106+
| webContextUnify | Specify whether unify web context(i.e. use the default context name). | `boolean` | `true` |
107+
108+
- `SentinelWebMvcTotalConfig` configuration:
109+
110+
| name | description | type | default value |
111+
| ------ | ------------ | ------ | ------- |
112+
| totalResourceName | The resource name in `SentinelTotalInterceptor` | `String` | `spring-mvc-total-url-request` |
113+
| requestAttributeName | Attribute key in request used by Sentinel (internal) | `String` | `$$sentinel_spring_web_total_entry_attr` |

‎sentinel-adapter/sentinel-spring-webmvc-v6x-adapter/README.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -85,23 +85,23 @@ config.setBlockExceptionHandler((request, response, e) -> {
8585

8686
- Common configuration in `SentinelWebMvcConfig` and `SentinelWebMvcTotalConfig`:
8787

88-
| name | description | type | default value |
89-
| ------ | ------------ | ------ | ------- |
90-
| `blockExceptionHandler` | The handler that handles the block request | `BlockExceptionHandler` | null (throw out the BlockException) |
91-
| `originParser` | Extracting request origin (e.g. IP or appName from HTTP Header) from HTTP request | `RequestOriginParser` | - |
88+
| name | description | type | default value |
89+
| ------ | ------------ | ------ | ------- |
90+
| `blockExceptionHandler` | The handler that handles the block request | `BlockExceptionHandler` | null (throw out the BlockException) |
91+
| `originParser` | Extracting request origin (e.g. IP or appName from HTTP Header) from HTTP request | `RequestOriginParser` | - |
9292

9393
- `SentinelWebMvcConfig` configuration:
9494

95-
| name | description | type | default value |
96-
| ------ | ------------ | ------ | ------- |
97-
| urlCleaner | The `UrlCleaner` interface is designed for clean and unify the URL resource. | `UrlCleaner` | - |
98-
| requestAttributeName | Attribute key in request used by Sentinel (internal) | `String` | `$$sentinel_spring_web_entry_attr` |
99-
| httpMethodSpecify | Specify whether the URL resource name should contain the HTTP method prefix (e.g. `POST:`). | `boolean` | `false` |
100-
| webContextUnify | Specify whether unify web context(i.e. use the default context name). | `boolean` | `true` |
95+
| name | description | type | default value |
96+
| ------ | ------------ | ------ | ------- |
97+
| urlCleaner | The `UrlCleaner` interface is designed for clean and unify the URL resource. | `UrlCleaner` | - |
98+
| requestAttributeName | Attribute key in request used by Sentinel (internal) | `String` | `$$sentinel_spring_web_entry_attr` |
99+
| httpMethodSpecify | Specify whether the URL resource name should contain the HTTP method prefix (e.g. `POST:`). | `boolean` | `false` |
100+
| webContextUnify | Specify whether unify web context(i.e. use the default context name). | `boolean` | `true` |
101101

102102
- `SentinelWebMvcTotalConfig` configuration:
103103

104-
| name | description | type | default value |
105-
| ------ | ------------ | ------ | ------- |
106-
| totalResourceName | The resource name in `SentinelTotalInterceptor` | `String` | `spring-mvc-total-url-request` |
107-
| requestAttributeName | Attribute key in request used by Sentinel (internal) | `String` | `$$sentinel_spring_web_total_entry_attr` |
104+
| name | description | type | default value |
105+
| ------ | ------------ | ------ | ------- |
106+
| totalResourceName | The resource name in `SentinelTotalInterceptor` | `String` | `spring-mvc-total-url-request` |
107+
| requestAttributeName | Attribute key in request used by Sentinel (internal) | `String` | `$$sentinel_spring_web_total_entry_attr` |

0 commit comments

Comments
 (0)