mirror of
https://github.com/spring-projects/spring-boot.git
synced 2024-08-29 03:06:45 +08:00
Merge pull request #19936 from dreis2211
* pr/19936: Fix broken documentation links Closes gh-19936
This commit is contained in:
commit
e325b8813b
@ -27,12 +27,12 @@
|
||||
:spring-boot-api: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/api/
|
||||
:spring-boot-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/reference
|
||||
:spring-boot-master-code: https://github.com/{github-repo}/tree/master
|
||||
:spring-boot-current-docs: https://docs.spring.io/spring-boot/docs/current/reference
|
||||
:spring-boot-current-docs: https://docs.spring.io/spring-boot/docs/current/reference/
|
||||
:spring-boot-actuator-restapi: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/actuator-api/
|
||||
:spring-boot-maven-plugin-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/maven-plugin/html/
|
||||
:spring-boot-gradle-plugin-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/gradle-plugin/reference/html/
|
||||
:spring-boot-gradle-plugin-pdfdocs: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/gradle-plugin/reference/pdf/spring-boot-gradle-plugin-reference.pdf
|
||||
:spring-boot-gradle-plugin-api: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/gradle-plugin/reference/api/
|
||||
:spring-boot-gradle-plugin-api: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/gradle-plugin/api/
|
||||
|
||||
:spring-boot-module-code: {spring-boot-code}/spring-boot-project/spring-boot/src/main/java/org/springframework/boot
|
||||
:spring-boot-module-api: {spring-boot-api}/org/springframework/boot
|
||||
|
@ -11,8 +11,8 @@ It serves as a map for the rest of the document.
|
||||
== About the Documentation
|
||||
The Spring Boot reference guide is available as:
|
||||
|
||||
* {spring-boot-docs}/html[Multi-page HTML]
|
||||
* {spring-boot-docs}/htmlsingle[Single page HTML]
|
||||
* {spring-boot-docs}/html/[Multi-page HTML]
|
||||
* {spring-boot-docs}/htmlsingle/[Single page HTML]
|
||||
* {spring-boot-docs}/pdf/spring-boot-reference.pdf[PDF]
|
||||
|
||||
The latest copy is available at {spring-boot-current-docs}.
|
||||
|
@ -703,7 +703,7 @@ To do so, insert the following lines just below the `dependencies` section:
|
||||
|
||||
NOTE: The `spring-boot-starter-parent` POM includes `<executions>` configuration to bind the `repackage` goal.
|
||||
If you do not use the parent POM, you need to declare this configuration yourself.
|
||||
See the {spring-boot-maven-plugin-docs}/usage.html[plugin documentation] for details.
|
||||
See the {spring-boot-maven-plugin-docs}#getting-started[plugin documentation] for details.
|
||||
|
||||
Save your `pom.xml` and run `mvn package` from the command line, as follows:
|
||||
|
||||
|
@ -156,7 +156,7 @@ NOTE: Only production configuration is filtered that way (in other words, no fil
|
||||
TIP: If you enable the `addResources` flag, the `spring-boot:run` goal can add `src/main/resources` directly to the classpath (for hot reloading purposes).
|
||||
Doing so circumvents the resource filtering and this feature.
|
||||
Instead, you can use the `exec:java` goal or customize the plugin's configuration.
|
||||
See the {spring-boot-maven-plugin-docs}/usage.html[plugin usage page] for more details.
|
||||
See the {spring-boot-maven-plugin-docs}#getting-started[plugin usage page] for more details.
|
||||
|
||||
If you do not use the starter parent, you need to include the following element inside the `<build/>` element of your `pom.xml`:
|
||||
|
||||
@ -2224,7 +2224,7 @@ If you define a `@Configuration` with a `WebSecurityConfigurerAdapter` in your a
|
||||
[[howto-change-the-user-details-service-and-add-user-accounts]]
|
||||
=== Change the UserDetailsService and Add User Accounts
|
||||
If you provide a `@Bean` of type `AuthenticationManager`, `AuthenticationProvider`, or `UserDetailsService`, the default `@Bean` for `InMemoryUserDetailsManager` is not created.
|
||||
This means you have the full feature set of Spring Security available (such as {spring-security-docs}#jc-authentication[various authentication options]).
|
||||
This means you have the full feature set of Spring Security available (such as {spring-security-docs}#servlet-authentication[various authentication options]).
|
||||
|
||||
The easiest way to add user accounts is to provide your own `UserDetailsService` bean.
|
||||
|
||||
@ -2369,7 +2369,7 @@ To generate build information with Maven, add an execution for the `build-info`
|
||||
</build>
|
||||
----
|
||||
|
||||
TIP: See the {spring-boot-maven-plugin-docs}/#build-info[Spring Boot Maven Plugin documentation] for more details.
|
||||
TIP: See the {spring-boot-maven-plugin-docs}#goals-build-info[Spring Boot Maven Plugin documentation] for more details.
|
||||
|
||||
The following example does the same with Gradle:
|
||||
|
||||
@ -2481,7 +2481,7 @@ However, you must additionally add an `<executions>` section, as follows:
|
||||
</build>
|
||||
----
|
||||
|
||||
See the {spring-boot-maven-plugin-docs}/usage.html[plugin documentation] for full usage details.
|
||||
See the {spring-boot-maven-plugin-docs}#getting-started[plugin documentation] for full usage details.
|
||||
|
||||
|
||||
|
||||
@ -2595,7 +2595,7 @@ In Maven, the executable jar must be the main artifact and you can add a classif
|
||||
=== Remote Debug a Spring Boot Application Started with Maven
|
||||
To attach a remote debugger to a Spring Boot application that was started with Maven, you can use the `jvmArguments` property of the {spring-boot-maven-plugin-docs}[maven plugin].
|
||||
|
||||
See {spring-boot-maven-plugin-docs}/examples/run-debug.html[this example] for more details.
|
||||
See {spring-boot-maven-plugin-docs}#run-example-debug[this example] for more details.
|
||||
|
||||
|
||||
|
||||
|
@ -25,4 +25,4 @@ The reference documentation has the following appendices:
|
||||
<<appendix-auto-configuration-classes.adoc#auto-configuration-classes,Auto-configuration Classes>> :: Auto-configuration classes provided by Spring Boot.
|
||||
<<appendix-test-auto-configuration.adoc#test-auto-configuration,Test Auto-configuration Annotations>> :: Test-autoconfiguration annotations used to test slices of your application.
|
||||
<<appendix-executable-jar-format.adoc#executable-jar,Executable Jars>> :: Spring Boot's executable jars, their launchers, and their format.
|
||||
<<appendix-dependency-versions.adoc#appendix-dependency-versions,Dependency Versions>> :: Details of the dependencies that are managed by Spring Boot.
|
||||
<<appendix-dependency-versions.adoc#dependency-versions,Dependency Versions>> :: Details of the dependencies that are managed by Spring Boot.
|
||||
|
@ -147,7 +147,7 @@ If your application is a web application (Spring MVC, Spring WebFlux, or Jersey)
|
||||
Requires a dependency on `micrometer-registry-prometheus`.
|
||||
|===
|
||||
|
||||
To learn more about the Actuator's endpoints and their request and response formats, please refer to the separate API documentation ({spring-boot-actuator-restapi}/html/[HTML] or {spring-boot-actuator-restapi}/pdf/spring-boot-actuator-web-api.pdf[PDF]).
|
||||
To learn more about the Actuator's endpoints and their request and response formats, please refer to the separate API documentation ({spring-boot-actuator-restapi}html/[HTML] or {spring-boot-actuator-restapi}pdf/spring-boot-actuator-web-api.pdf[PDF]).
|
||||
|
||||
|
||||
|
||||
@ -363,7 +363,7 @@ A typical Spring Security configuration might look something like the following
|
||||
|
||||
The preceding example uses `EndpointRequest.toAnyEndpoint()` to match a request to any endpoint and then ensures that all have the `ENDPOINT_ADMIN` role.
|
||||
Several other matcher methods are also available on `EndpointRequest`.
|
||||
See the API documentation ({spring-boot-actuator-restapi}/html[HTML] or {spring-boot-actuator-restapi}/pdf/spring-boot-actuator-web-api.pdf[PDF]) for details.
|
||||
See the API documentation ({spring-boot-actuator-restapi}html[HTML] or {spring-boot-actuator-restapi}pdf/spring-boot-actuator-web-api.pdf[PDF]) for details.
|
||||
|
||||
If you deploy applications behind a firewall, you may prefer that all your actuator endpoints can be accessed without requiring authentication.
|
||||
You can do so by changing the configprop:management.endpoints.web.exposure.include[] property, as follows:
|
||||
|
@ -3249,7 +3249,7 @@ Alternatively, you can define your own `OpaqueTokenIntrospector` bean for servle
|
||||
==== Authorization Server
|
||||
Currently, Spring Security does not provide support for implementing an OAuth 2.0 Authorization Server.
|
||||
However, this functionality is available from the {spring-security-oauth2}[Spring Security OAuth] project, which will eventually be superseded by Spring Security completely.
|
||||
Until then, you can use the `spring-security-oauth2-autoconfigure` module to easily set up an OAuth 2.0 authorization server; see its https://docs.spring.io/spring-security-oauth2-boot[documentation] for instructions.
|
||||
Until then, you can use the `spring-security-oauth2-autoconfigure` module to easily set up an OAuth 2.0 authorization server; see its https://docs.spring.io/spring-security-oauth2-boot/[documentation] for instructions.
|
||||
|
||||
|
||||
[[boot-features-security-saml]]
|
||||
@ -4393,7 +4393,7 @@ TIP: If you want to fully bypass the auto-configuration for Spring Data Couchbas
|
||||
[[boot-features-ldap]]
|
||||
=== LDAP
|
||||
https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol[LDAP] (Lightweight Directory Access Protocol) is an open, vendor-neutral, industry standard application protocol for accessing and maintaining distributed directory information services over an IP network.
|
||||
Spring Boot offers auto-configuration for any compliant LDAP server as well as support for the embedded in-memory LDAP server from https://www.ldap.com/unboundid-ldap-sdk-for-java[UnboundID].
|
||||
Spring Boot offers auto-configuration for any compliant LDAP server as well as support for the embedded in-memory LDAP server from https://ldap.com/unboundid-ldap-sdk-for-java/[UnboundID].
|
||||
|
||||
LDAP abstractions are provided by https://github.com/spring-projects/spring-data-ldap[Spring Data LDAP].
|
||||
There is a `spring-boot-starter-data-ldap` "`Starter`" for collecting the dependencies in a convenient way.
|
||||
@ -7234,7 +7234,7 @@ These annotations include:
|
||||
[[boot-features-class-conditions]]
|
||||
==== Class Conditions
|
||||
The `@ConditionalOnClass` and `@ConditionalOnMissingClass` annotations let `@Configuration` classes be included based on the presence or absence of specific classes.
|
||||
Due to the fact that annotation metadata is parsed by using https://asm.ow2.org/[ASM], you can use the `value` attribute to refer to the real class, even though that class might not actually appear on the running application classpath.
|
||||
Due to the fact that annotation metadata is parsed by using https://asm.ow2.io/[ASM], you can use the `value` attribute to refer to the real class, even though that class might not actually appear on the running application classpath.
|
||||
You can also use the `name` attribute if you prefer to specify the class name by using a `String` value.
|
||||
|
||||
This mechanism does not apply the same way to `@Bean` methods where typically the return type is the target of the condition: before the condition on the method applies, the JVM will have loaded the class and potentially processed method references which will fail if the class is not present.
|
||||
|
@ -44,7 +44,7 @@ The parent project provides the following features:
|
||||
* UTF-8 source encoding.
|
||||
* A <<using-boot-dependency-management,Dependency Management section>>, inherited from the spring-boot-dependencies pom, that manages the versions of common dependencies.
|
||||
This dependency management lets you omit <version> tags for those dependencies when used in your own pom.
|
||||
* An execution of the {spring-boot-maven-plugin-docs}/repackage-mojo.html[`repackage` goal] with a `repackage` execution id.
|
||||
* An execution of the {spring-boot-maven-plugin-docs}#goals-repackage[`repackage` goal] with a `repackage` execution id.
|
||||
* Sensible https://maven.apache.org/plugins/maven-resources-plugin/examples/filter.html[resource filtering].
|
||||
* Sensible plugin configuration (https://www.mojohaus.org/exec-maven-plugin/[exec plugin], https://github.com/ktoso/maven-git-commit-id-plugin[Git commit ID], and https://maven.apache.org/plugins/maven-shade-plugin/[shade]).
|
||||
* Sensible resource filtering for `application.properties` and `application.yml` including profile-specific files (for example, `application-dev.properties` and `application-dev.yml`)
|
||||
|
Loading…
Reference in New Issue
Block a user