Package net.officefloor.spring.starter.rest

Class OfficeFloorOpenApiConfiguration.OptionalOpenApiConfiguration

java.lang.Object

net.officefloor.spring.starter.rest.OfficeFloorOpenApiConfiguration.OptionalOpenApiConfiguration

Enclosing class:

OfficeFloorOpenApiConfiguration

@Configuration
@ConditionalOnClass(name="org.springdoc.core.customizers.OpenApiCustomizer")
public static class OfficeFloorOpenApiConfiguration.OptionalOpenApiConfiguration
extends Object

Optional OpenAPI configuration loaded only when springdoc is on the classpath.

Constructor Summary

Constructors

Constructor	Description
OptionalOpenApiConfiguration()

Method Summary

Modifier and Type	Method	Description
org.springdoc.core.customizers.OpenApiCustomizer	officeFloorOpenApiCustomizer(OfficeFloorRestSpringBootStarter starter)	Creates the OpenApiCustomizer for OfficeFloor.

Methods inherited from class java.lang.Object

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

Constructor Details

OptionalOpenApiConfiguration

public OptionalOpenApiConfiguration()

Method Details

officeFloorOpenApiCustomizer

@Bean
public org.springdoc.core.customizers.OpenApiCustomizer officeFloorOpenApiCustomizer(OfficeFloorRestSpringBootStarter starter)
                                                                              throws Exception

Creates the OpenApiCustomizer for OfficeFloor.

Parameters:

starter - OfficeFloorRestSpringBootStarter.

Returns:

OpenApiCustomizer.

Throws:

Exception - If fails to create the customizer.