Adding Actuator as a groupedOpenApi ?

[ysmimaa]

Hi
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

[bnasslahsen]

Hi @Yawyaw1,

Using the definition you shared, we can add actuator as GroupedOpenAPI.
Depending on project requirements, they can add it.

[ysmimaa]

Hi @bnasslahden,

Thank you for your answer, however i was wondering if there is a way to handle this like swagger 2 by implementing The Swagger OperationBuilderPlugin in order to expose it ?

Thanks

[bnasslahsen]

@Yawyaw1,

We do not have such a class while using OpenAPI 3.
GroupedOpenAPI, is enough.

[ysmimaa]

I think GroupedOpenApi can't handle this right now, cause it needs the package to scan where is the openApi annonation in order to expose the endpoits !
And we don't have access to actuator's package so it will never happen.

[bnasslahsen]

Your description is not clear. GroupedOpenApi is working with actuator and you can simply set your own group.

If you think there is any issue with it using actuator, you can submit more details by describing all the elements described in the section Using GitHub Issues.

• https://github.com/springdoc/springdoc-openapi/blob/master/CONTRIBUTING.adoc

[ysmimaa]

Could you provide me an example of groupedOpenApi using actuator, please
Because when i set my own group for actuator

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

i get an empty page with the message No operations defined in spec! as displyed on the image

[bnasslahsen]

Did you add springdoc.show-actuator=true ?

[ysmimaa]

Yes

[bnasslahsen]

And you still didn't succeed ?

[ysmimaa]

No, always an empty page, and i don't know how to display it

[bnasslahsen]

You can have a look at the demo2, which is using actuator as a group.

• https://github.com/springdoc/springdoc-openapi-demos/tree/master/springdoc-openapi-test-app2

Here are the steps of using actuator:

• springdoc/springdoc-openapi-demos@aa6bcf1

[ysmimaa]

Now, it's working, the problem was related to my version 1.2.22, i change it to 1.3.0 and it seems ok

Thank you @bnasslahsen apreciate