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

Add HandlerMethod and HandlerFunction details to mappings endpoint

Browse Source 
Closes gh-11864
This commit is contained in:
Andy Wilkinson
2018-02-07 16:31:40 +00:00
parent 7ed4273fc3
commit 2c19257d6d
11 changed files with 293 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/mappings.adoc
View File

@@ -40,7 +40,7 @@ When using Spring MVC, the response contains details of any `DispatcherServlet`
request mappings beneath `contexts.*.mappings.dispatcherServlets`. The following
table describes the structure of this section of the response:
[cols="2,1,3"]
[cols="3,1,3"]
include::{snippets}mappings/response-fields-dispatcher-servlets.adoc[]
@@ -69,12 +69,12 @@ include::{snippets}mappings/response-fields-servlet-filters.adoc[]
[[mappings-retrieving-response-structure-dispatcher-servlets]]
[[mappings-retrieving-response-structure-dispatcher-handlers]]
=== Dispatcher Handlers Response Structure
When using Spring WebFlux, the response contains details of any `DispatcherHandler`
request mappings beneath `contexts.*.mappings.dispatcherHandlers`. The following
table describes the structure of this section of the response:
[cols="2,1,3"]
[cols="3,1,3"]
include::{snippets}mappings/response-fields-dispatcher-handlers.adoc[]

43
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/MappingsEndpointReactiveDocumentationTests.java
View File

@@ -35,8 +35,13 @@ import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.restdocs.JUnitRestDocumentation;
import org.springframework.restdocs.payload.JsonFieldType;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.reactive.server.WebTestClient;
import org.springframework.web.reactive.function.server.RequestPredicates;
import org.springframework.web.reactive.function.server.RouterFunction;
import org.springframework.web.reactive.function.server.RouterFunctions;
import org.springframework.web.reactive.function.server.ServerResponse;
import static org.springframework.restdocs.payload.PayloadDocumentation.beneathPath;
import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
@@ -84,7 +89,37 @@ public class MappingsEndpointReactiveDocumentationTests
fieldWithPath("*.[].handler")
.description("Handler for the mapping."),
fieldWithPath("*.[].predicate")
.description("Predicate for the mapping."))));
.description("Predicate for the mapping."),
fieldWithPath("*.[].details").optional()
.type(JsonFieldType.OBJECT)
.description("Additional implementation-specific "
+ "details about the mapping. Optional."),
fieldWithPath("*.[].details.handlerMethod").optional()
.type(JsonFieldType.OBJECT)
.description("Details of the method, if any, "
+ "that will handle requests to "
+ "this mapping."),
fieldWithPath("*.[].details.handlerMethod.className")
.type(JsonFieldType.STRING)
.description("Fully qualified name of the class"
+ " of the method."),
fieldWithPath("*.[].details.handlerMethod.name")
.type(JsonFieldType.STRING)
.description("Name of the method."),
fieldWithPath("*.[].details.handlerMethod.descriptor")
.type(JsonFieldType.STRING)
.description("Descriptor of the method as "
+ "specified in the Java Language "
+ "Specification."),
fieldWithPath("*.[].details.handlerFunction")
.optional().type(JsonFieldType.OBJECT)
.description("Details of the function, if any, "
+ "that will handle requests to this "
+ "mapping."),
fieldWithPath("*.[].details.handlerFunction.className")
.type(JsonFieldType.STRING).description(
"Fully qualified name of the class of "
+ "the function."))));
}
@Configuration
@@ -108,6 +143,12 @@ public class MappingsEndpointReactiveDocumentationTests
return new MappingsEndpoint(descriptionProviders, context);
}
@Bean
public RouterFunction<ServerResponse> exampleRouter() {
return RouterFunctions.route(RequestPredicates.GET("/foo"),
(request) -> ServerResponse.ok().build());
}
}
}

23
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/MappingsEndpointServletDocumentationTests.java
View File

@@ -102,7 +102,28 @@ public class MappingsEndpointServletDocumentationTests
fieldWithPath("*.[].handler")
.description("Handler for the mapping."),
fieldWithPath("*.[].predicate")
.description("Predicate for the mapping.")),
.description("Predicate for the mapping."),
fieldWithPath("*.[].details").optional()
.type(JsonFieldType.OBJECT)
.description("Additional implementation-specific "
+ "details about the mapping. Optional."),
fieldWithPath("*.[].details.handlerMethod").optional()
.type(JsonFieldType.OBJECT)
.description("Details of the method, if any, "
+ "that will handle requests to "
+ "this mapping."),
fieldWithPath("*.[].details.handlerMethod.className")
.type(JsonFieldType.STRING)
.description("Fully qualified name of the class"
+ " of the method."),
fieldWithPath("*.[].details.handlerMethod.name")
.type(JsonFieldType.STRING)
.description("Name of the method."),
fieldWithPath("*.[].details.handlerMethod.descriptor")
.type(JsonFieldType.STRING)
.description("Descriptor of the method as "
+ "specified in the Java Language "
+ "Specification.")),
responseFields(
beneathPath("contexts.*.mappings.servletFilters")
.withSubsectionId("servlet-filters"),