org.springframework.boot.actuate.endpoint.mvc

Class DocsMvcEndpoint

java.lang.Object

org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter

org.springframework.boot.actuate.endpoint.mvc.AbstractMvcEndpoint

org.springframework.boot.actuate.endpoint.mvc.AbstractNamedMvcEndpoint

org.springframework.boot.actuate.endpoint.mvc.DocsMvcEndpoint

All Implemented Interfaces:

org.springframework.beans.factory.Aware, MvcEndpoint, NamedMvcEndpoint, org.springframework.context.EnvironmentAware, org.springframework.web.servlet.config.annotation.WebMvcConfigurer

@ConfigurationProperties(prefix="endpoints.docs")
public class DocsMvcEndpoint
extends AbstractNamedMvcEndpoint

MvcEndpoint to expose actuator documentation.

Since:

1.3.0

Author:

Dave Syer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocsMvcEndpoint.Curies Properties of the default CurieProvider (used for adding docs links).

Field Summary

Fields inherited from interface org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint

DISABLED_RESPONSE

Constructor Summary

Constructors

Constructor and Description
DocsMvcEndpoint(ManagementServletContext managementServletContext)

Method Summary

Modifier and Type	Method and Description
void	addResourceHandlers(org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry registry)
String	browse()
DocsMvcEndpoint.Curies	getCuries()
String	redirect()

Methods inherited from class org.springframework.boot.actuate.endpoint.mvc.AbstractNamedMvcEndpoint

getName

Methods inherited from class org.springframework.boot.actuate.endpoint.mvc.AbstractMvcEndpoint

getEndpointType, getEnvironment, getPath, isEnabled, isSensitive, setEnabled, setEnvironment, setPath, setSensitive

Methods inherited from class org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter

addArgumentResolvers, addCorsMappings, addFormatters, addInterceptors, addReturnValueHandlers, addViewControllers, configureAsyncSupport, configureContentNegotiation, configureDefaultServletHandling, configureHandlerExceptionResolvers, configureMessageConverters, configurePathMatch, configureViewResolvers, extendHandlerExceptionResolvers, extendMessageConverters, getMessageCodesResolver, getValidator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint

getEndpointType, getPath, isSensitive

Constructor Detail

DocsMvcEndpoint

public DocsMvcEndpoint(ManagementServletContext managementServletContext)

Method Detail

getCuries

public DocsMvcEndpoint.Curies getCuries()

browse

@RequestMapping(value="/",
                produces="text/html")
public String browse()

redirect

@RequestMapping(value="",
                produces="text/html")
public String redirect()

addResourceHandlers

public void addResourceHandlers(org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry registry)

Specified by:

addResourceHandlers in interface org.springframework.web.servlet.config.annotation.WebMvcConfigurer

Overrides:

addResourceHandlers in class org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter