Skip to content

Commit 89642f0

Browse files
committed
Add link to appendix from error handling
Improve documentation by adding a link from the "Error Handling" section to the appendix. Closes gh-24265
1 parent 6ee1db7 commit 89642f0

File tree

2 files changed

+51
-17
lines changed

2 files changed

+51
-17
lines changed

spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc

Lines changed: 47 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,66 +14,96 @@ Also, you can define your own properties.
1414

1515

1616

17-
== Core properties
18-
17+
[[common-application-properties-core]]
18+
== Core properties [[core-properties]]
1919
include::{generated-resources-root}/config-docs/core.adoc[]
2020

21-
== Cache properties
2221

22+
23+
[[common-application-properties-cache]]
24+
== Cache properties [[cache-properties]]
2325
include::{generated-resources-root}/config-docs/cache.adoc[]
2426

25-
== Mail properties
2627

28+
29+
[[common-application-properties-mail]]
30+
== Mail properties [[mail-properties]]
2731
include::{generated-resources-root}/config-docs/mail.adoc[]
2832

29-
== JSON properties
3033

34+
35+
[[common-application-properties-json]]
36+
== JSON properties [[json-properties]]
3137
include::{generated-resources-root}/config-docs/json.adoc[]
3238

33-
== Data properties
3439

40+
41+
[[common-application-properties-data]]
42+
== Data properties [[data-properties]]
3543
include::{generated-resources-root}/config-docs/data.adoc[]
3644

37-
== Transaction properties
3845

46+
47+
[[common-application-properties-transaction]]
48+
== Transaction properties [[transaction-properties]]
3949
include::{generated-resources-root}/config-docs/transaction.adoc[]
4050

41-
== Data migration properties
4251

52+
53+
[[common-application-properties-data-migration]]
54+
== Data migration properties [[data-migration-properties]]
4355
include::{generated-resources-root}/config-docs/data-migration.adoc[]
4456

45-
== Integration properties
4657

58+
59+
[[common-application-properties-integration]]
60+
== Integration properties [[integration-properties]]
4761
include::{generated-resources-root}/config-docs/integration.adoc[]
4862

49-
== Web properties
5063

64+
65+
[[common-application-properties-web]]
66+
== Web properties [[web-properties]]
5167
include::{generated-resources-root}/config-docs/web.adoc[]
5268

53-
== Templating properties
5469

70+
71+
[[common-application-properties-templating]]
72+
== Templating properties [[templating-properties]]
5573
include::{generated-resources-root}/config-docs/templating.adoc[]
5674

57-
== Server properties
5875

76+
77+
[[common-application-properties-server]]
78+
== Server properties [[server-properties]]
5979
include::{generated-resources-root}/config-docs/server.adoc[]
6080

61-
== Security properties
6281

82+
83+
[[common-application-properties-security]]
84+
== Security properties [[security-properties]]
6385
include::{generated-resources-root}/config-docs/security.adoc[]
6486

65-
== RSocket properties
6687

88+
89+
[[common-application-properties-rsocket]]
90+
== RSocket properties [[rsocket-properties]]
6791
include::{generated-resources-root}/config-docs/rsocket.adoc[]
6892

69-
== Actuator properties
7093

94+
95+
[[common-application-properties-actuator]]
96+
== Actuator properties [[actuator-properties]]
7197
include::{generated-resources-root}/config-docs/actuator.adoc[]
7298

73-
== Devtools properties
7499

100+
101+
[[common-application-properties-devtools]]
102+
== Devtools properties [[devtools-properties]]
75103
include::{generated-resources-root}/config-docs/devtools.adoc[]
76104

77-
== Testing properties
78105

106+
107+
[[common-application-properties-testing]]
108+
== Testing properties [[testing-properties]]
79109
include::{generated-resources-root}/config-docs/testing.adoc[]

spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2346,6 +2346,10 @@ If you have this problem, you can reorder the classpath in the IDE to place the
23462346
By default, Spring Boot provides an `/error` mapping that handles all errors in a sensible way, and it is registered as a "`global`" error page in the servlet container.
23472347
For machine clients, it produces a JSON response with details of the error, the HTTP status, and the exception message.
23482348
For browser clients, there is a "`whitelabel`" error view that renders the same data in HTML format (to customize it, add a `View` that resolves to `error`).
2349+
2350+
There are a number of `server.error` properties that can be set if you want to customize the default error handling behavior.
2351+
See the <<appendix-application-properties.adoc#common-application-properties-server, "`Server Properties`">> section of the Appendix.
2352+
23492353
To replace the default behavior completely, you can implement `ErrorController` and register a bean definition of that type or add a bean of type `ErrorAttributes` to use the existing mechanism but replace the contents.
23502354

23512355
TIP: The `BasicErrorController` can be used as a base class for a custom `ErrorController`.

0 commit comments

Comments
 (0)