Package tech.jhipster.config.apidoc

Class JHipsterSpringDocGroupsConfiguration

java.lang.Object

tech.jhipster.config.apidoc.JHipsterSpringDocGroupsConfiguration

@Configuration
public class JHipsterSpringDocGroupsConfiguration
extends Object

OpenApi Groups configuration.

Warning! When having a lot of REST endpoints, OpenApi can become a performance issue. In that case, you can use the "no-api-docs" Spring profile, so that this bean is ignored.

Field Summary

Fields

Modifier and Type	Field	Description
static String	MANAGEMENT_GROUP_NAME

Constructor Summary

Constructors

Constructor	Description
JHipsterSpringDocGroupsConfiguration(JHipsterProperties jHipsterProperties)	Constructor for OpenApiAutoConfiguration.

Method Summary

Modifier and Type	Method	Description
JHipsterOpenApiCustomizer	jhipsterOpenApiCustomizer()	JHipster OpenApi Customiser
org.springdoc.core.GroupedOpenApi	openAPIDefaultGroupedOpenAPI(List<org.springdoc.core.customizers.OpenApiCustomiser> openApiCustomisers, List<org.springdoc.core.customizers.OperationCustomizer> operationCustomizers, Optional<org.springdoc.core.GroupedOpenApi> apiFirstGroupedOpenAPI, org.springdoc.core.SpringDocConfigProperties springDocConfigProperties)	OpenApi default group configuration.
org.springdoc.core.GroupedOpenApi	openAPIManagementGroupedOpenAPI(String appName, org.springdoc.core.customizers.ActuatorOpenApiCustomizer actuatorOpenApiCustomiser, org.springdoc.core.customizers.ActuatorOperationCustomizer actuatorCustomizer)	OpenApi management group configuration for the management endpoints (actuator) OpenAPI docs.

Methods inherited from class java.lang.Object

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

Field Detail

MANAGEMENT_GROUP_NAME

public static final String MANAGEMENT_GROUP_NAME

See Also:

Constant Field Values

Constructor Detail

JHipsterSpringDocGroupsConfiguration

public JHipsterSpringDocGroupsConfiguration(JHipsterProperties jHipsterProperties)

Constructor for OpenApiAutoConfiguration.

Parameters:

jHipsterProperties - a JHipsterProperties object.

Method Detail

jhipsterOpenApiCustomizer

@Bean
public JHipsterOpenApiCustomizer jhipsterOpenApiCustomizer()

JHipster OpenApi Customiser

Returns:

the Customizer of JHipster

openAPIDefaultGroupedOpenAPI

@Bean
@ConditionalOnMissingBean(name="openAPIDefaultGroupedOpenAPI")
public org.springdoc.core.GroupedOpenApi openAPIDefaultGroupedOpenAPI(List<org.springdoc.core.customizers.OpenApiCustomiser> openApiCustomisers,
                                                                      List<org.springdoc.core.customizers.OperationCustomizer> operationCustomizers,
                                                                      @Qualifier("apiFirstGroupedOpenAPI")
                                                                      Optional<org.springdoc.core.GroupedOpenApi> apiFirstGroupedOpenAPI,
                                                                      org.springdoc.core.SpringDocConfigProperties springDocConfigProperties)

OpenApi default group configuration.

Returns:

the GroupedOpenApi configuration

openAPIManagementGroupedOpenAPI

@Bean
@ConditionalOnClass(name="org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties")
@ConditionalOnMissingBean(name="openAPIManagementGroupedOpenAPI")
@ConditionalOnProperty("springdoc.show-actuator")
public org.springdoc.core.GroupedOpenApi openAPIManagementGroupedOpenAPI(@Value("${spring.application.name:application}")
                                                                         String appName,
                                                                         org.springdoc.core.customizers.ActuatorOpenApiCustomizer actuatorOpenApiCustomiser,
                                                                         org.springdoc.core.customizers.ActuatorOperationCustomizer actuatorCustomizer)

OpenApi management group configuration for the management endpoints (actuator) OpenAPI docs.

Returns:

the GroupedOpenApi configuration