root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 15 Packages Projects Releases Wiki Activity

Improve actuator documentation about the types supported for endpoints 

Closes gh-13896
This commit is contained in:
Stephane Nicoll 2018-08-24 17:08:29 +02:00
parent f5482a33a3
commit f53e6c701f
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -532,6 +532,24 @@ JSON request body. When exposed via JMX, the parameters are mapped to the parame
the MBean's operations. Parameters are required by default. They can be made optional the MBean's operations. Parameters are required by default. They can be made optional
by annotating them with `@org.springframework.lang.Nullable`. by annotating them with `@org.springframework.lang.Nullable`.
Each root property in the JSON request body can be mapped to a parameter of the endpoint.
Consider the following JSON request body:
[source,json,indent=0]
----
{
"name": "test",
"counter": 42
}
----
This can be used to invoke a write operation that takes a `String test` and `int counter`
parameters.
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.
NOTE: To allow the input to be mapped to the operation method's parameters, Java code 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 `-parameters`, and Kotlin code
implementing an endpoint should be compiled with `-java-parameters`. This will happen implementing an endpoint should be compiled with `-java-parameters`. This will happen