About InspeKtor¶

InspeKtor is a Kotlin compiler plugin that generates OpenAPI specifications from your Ktor routing code.

Why InspeKtor?¶

The Problem¶

Keeping API documentation in sync with code is hard:

• Annotation-based tools require verbose annotations that duplicate your code
• Runtime tools need your server running and may miss edge cases
• Manual specs quickly become outdated

The Solution¶

InspeKtor analyzes your Ktor routing DSL at compile time and generates accurate OpenAPI documentation automatically. It:

• Reads your actual route definitions
• Infers request/response types from your code
• Extracts documentation from KDoc comments
• Generates the spec as part of your normal build

Key Features¶

How It Works¶

┌─────────────────┐     ┌──────────────────┐     ┌─────────────────┐
│   Kotlin Code   │────▶│ Compiler Plugin  │────▶│  OpenAPI Spec   │
│                 │     │                  │     │                 │
│ • Routes        │     │ • Analyzes DSL   │     │ • paths         │
│ • Data classes  │     │ • Resolves types │     │ • schemas       │
│ • Annotations   │     │ • Extracts docs  │     │ • security      │
└─────────────────┘     └──────────────────┘     └─────────────────┘

1. You write Ktor routes normally
2. Add @GenerateOpenApi to your module function
3. Build your project
4. Get a complete OpenAPI specification

Project Links¶

• GitHub Repository
• Maven Central
• Issue Tracker

About This Documentation¶

This documentation is built with MkDocs and the Material for MkDocs theme.

Acknowledgments¶

InspeKtor is built on top of:

• Kotlin Compiler Plugin API
• Ktor Framework
• OpenAPI Specification