Skip to content

Overview

You can use the Ktorceful annotation to automatically create ktor routing for your classes.

To use the ktorceful annotation, you must install Ktor Resource plugin

Example class

@Ktorceful
@Resource("/your-api")
class YourAPI: Get, Post {
    override fun get(call: RoutingCall) {
        //...
    }

    override fun post(call: RoutingCall) {
        //...
    }
}

Define route

All annotated classes will have their routing generated automatically. You can call them all once using the allKtorcefulRoutes() extension.

fun Application.module() {
    install(Resources)

    allKtorcefulRoutes() // You can call this once for all routes!

    // Or if you need more control you can use the following format
    // ktorceful{ClassName}Route() 
    ktorcefulYourAPIRoute()
}