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

OpenApiFragment

interface OpenApiFragment(source)

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.

Properties

Link copied to clipboard
abstract val basePath: String

The base API path for this plugin (e.g., "/api/plugins/dbdemo").

Link copied to clipboard
open val description: String

Optional description for this plugin's API section.

Link copied to clipboard
abstract val pluginId: String

The unique plugin identifier (e.g., "dbdemo").

Link copied to clipboard
abstract val title: String

Human-readable title for this plugin's API group.

Link copied to clipboard
open val version: String

API version string.

Generated by Dokka
© 2026 Copyright