wow-spring-boot-starter/me.ahoo.wow.spring.boot.starter.openapi

Package-level declarations

Types

ConditionalOnOpenAPIEnabled

@ConditionalOnClass(name = ["me.ahoo.wow.openapi.RouterSpecs"])

@ConditionalOnProperty(value = ["wow.openapi.enabled"], matchIfMissing = true, havingValue = "true")

annotation class ConditionalOnOpenAPIEnabled

OpenAPIAutoConfiguration

@AutoConfiguration

@ConditionalOnClass(name = ["me.ahoo.wow.openapi.RouterSpecs"])

@EnableConfigurationProperties(value = [OpenAPIProperties::class])

class OpenAPIAutoConfiguration

OpenApiDocumentFilter

fun interface OpenApiDocumentFilter

Changes the OpenAPI document right after WowOpenApiCustomizer has merged Wow's routes into it, so it sees those routes whatever order springdoc runs its customizers in. Declare one as a bean; several run in their order (org.springframework.core.Ordered or org.springframework.core.annotation.Order).

OpenAPIProperties

@ConfigurationProperties(prefix = "wow.openapi")

class OpenAPIProperties(var enabled: Boolean = true) : EnabledCapable

WowOpenApiCustomizer

class WowOpenApiCustomizer(routerSpecs: RouterSpecs, documentFilters: List<OpenApiDocumentFilter>) : OpenApiCustomizer

Merges Wow's routes into the OpenAPI document, then applies the documentFilters in the order given.

Properties

ENABLED_KEY

const val ENABLED_KEY: String