Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch '2.2.x' into 2.3.x

Browse Source 
Closes gh-23060
This commit is contained in:
Stephane Nicoll
2020-08-24 11:57:22 +02:00
parent 1f7d8f2180 c2b69d560a
commit 39dc2e7de4
2 changed files with 72 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
spring-boot-project/spring-boot-docs/src/docs/asciidoc/production-ready-features.adoc
View File

@@ -443,6 +443,13 @@ If you add a `@Bean` annotated with `@Endpoint`, any methods annotated with `@Re
Endpoints can be exposed over HTTP using Jersey, Spring MVC, or Spring WebFlux.
If both Jersey and Spring MVC are available, Spring MVC will be used.
The following example exposes a read operation that returns a custom object:
[source,java,indent=0]
----
include::{code-examples}/actuate/endpoint/CustomEndpointExample.java[tag=read]
----
You can also write technology-specific endpoints by using `@JmxEndpoint` or `@WebEndpoint`.
These endpoints are restricted to their respective technologies.
For example, `@WebEndpoint` is exposed only over HTTP and not over JMX.
@@ -473,10 +480,15 @@ Consider the following JSON request body:
}
----
This can be used to invoke a write operation that takes `String name` and `int counter` parameters.
This can be used to invoke a write operation that takes `String name` and `int counter` parameters, as shown in the following example:
[source,java,indent=0]
----
include::{code-examples}/actuate/endpoint/CustomEndpointExample.java[tag=write]
----
TIP: Because endpoints are technology agnostic, only simple types can be specified in the method signature.
In particular declaring a single parameter with a custom type defining a `name` and `counter` properties is not supported.
In particular declaring a single parameter with a `CustomData` type defining a `name` and `counter` properties is not supported.
NOTE: To allow the input to be mapped to the operation method's parameters, Java code implementing an endpoint should be compiled with `-parameters`, and Kotlin code implementing an endpoint should be compiled with `-java-parameters`.
This will happen automatically if you are using Spring Boot's Gradle plugin or if you are using Maven and `spring-boot-starter-parent`.