Search code examples
springspringdocspringdoc-openapi-uispringdoc-openuispringdoc-ui

Adding Actuator as a groupedOpenApi


Could we add Actuator endpoints as a groupedOpenApi that will be gourped separately ?

ex :

@bean
public GroupedOpenApi actuatorApi() {
return GroupedOpenApi.builder().setGroup("Actuator")
.packagesToScan("org.springframework.boot.actuate")
.pathsToMatch("/actuator/**")
.build();
}

Thanks


Solution

  • First you need to enable actuator on the swagger-ui:

    springdoc.show-actuator=true
    

    You just need to declare GroupedOpenApi bean:

    @Bean
     public GroupedOpenApi actuatorApi(){
         String[] paths = {"/actuator/**"};
         return GroupedOpenApi.builder()
                 .setGroup("groups")
                 .pathsToMatch(paths)
                 .build();
     } 
    

    Here are the steps to add actuator:

    https://github.com/springdoc/springdoc-openapi-demos/commit/aa6bcf1f0312c8fc36f94aeb4653718b36c308f6