keel-openapi-runtime/com.keel.openapi.runtime

Package-level declarations

Types

Discovers OpenApiFragment implementations via ServiceLoader and merges runtime-registered operations into a unified OpenAPI 3.1.0 specification.

OpenApiDoc

data class OpenApiDoc(val summary: String = "", val description: String = "", val tags: List<String> = emptyList(), val successStatus: Int = 200, val errorStatuses: Set<Int> = emptySet(), val responseEnvelope: Boolean = false)

OpenApiFragment

interface OpenApiFragment

Interface for KSP-generated OpenAPI fragment registry objects. Each plugin annotated with @KeelApiPlugin gets a generated object implementing this interface. Fragments are discovered at runtime via ServiceLoader for spec aggregation.

OpenApiOperation

data class OpenApiOperation(val method: HttpMethod, val path: String, val requestBodyType: KType? = null, val responseBodyType: KType? = null, val responseContentTypes: List<String>? = null, val typeBound: Boolean = false, val summary: String = "", val description: String = "", val tags: List<String> = emptyList(), val responseEnvelope: Boolean = false, val successStatus: Int = 200, val errorStatuses: Set<Int> = emptySet())

OpenApiRegistry

object OpenApiRegistry

OpenApiSchemaGenerator

class OpenApiSchemaGenerator

ResourceReader

object ResourceReader

Functions

openApiRoutes

fun Route.openApiRoutes()

Installs OpenAPI documentation routes under the given route scope.