State of the OpenAPI generation from the code

[Stexxe]

Currently, there are few ways to create an OpenAPI specification for Ktor projects. You can generate one at runtime or through static analysis using the Ktor IntelliJ IDEA plugin.

Runtime Generation

These tools use runtime information to generate the specification:

• ktor-openapi-tools: Extends Ktor DSL to be able to annotate the server with information required to generate the OpenAPI specification.
• Tegral OpenAPI: Adds a capability to "describe" the server application and endpoints.
• ktor-openapi-generator: Adds new ways to create the annotated routes.
• Kompendium (no longer maintained): Provides plugins to "notarize" the routes.

Future Plans

The Ktor team plans to add built-in support for generating the OpenAPI specification (see issue KTOR-8316).