KeelApi

annotation class KeelApi(val summary: String = "", val description: String = "", val tags: Array<String> = [], val successStatus: Int = 200, val errorStatuses: IntArray = [], val responseEnvelope: Boolean = false)(source)

Deprecated (with error)

Use DSL doc = OpenApiDoc(...) instead of @KeelApi.

Primary annotation for documenting Ktor route handlers in Keel.

Place on each get/post/put/delete handler to include it in the auto-generated OpenAPI specification.

Parameters

summary

Short human-readable summary of what this endpoint does

description

Optional longer description with details

tags

OpenAPI tags for grouping endpoints (e.g., "notes", "crud")

successStatus

Success HTTP status documented for this endpoint

errorStatuses

Error HTTP statuses documented for this endpoint

responseEnvelope

Whether the response schema should be wrapped as KeelResponse

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val successStatus: Int = 200
Link copied to clipboard
Link copied to clipboard