Ktor: List of all routes

Created on 29 Jul 2019 · 2Comments · Source: ktorio/ktor

https://github.com/ktorio/ktor/issues/788Subsystem
Server

Is your feature request related to a problem? Please describe.
No

Describe the solution you'd like
Things like spring actuator are able to list all the endpoints in the current system. Something like this for ktor would be very helpful.

Motivation to include to ktor
A very common usage so makes sense to build directly into ktor.

feature

Source

sksamuel

❤8 👍2

Most helpful comment

I was interested logging all computed routes on service startup, in a cheap way, so did a small investigation.

You can traverse the tree of Routes, picking out leaves by filtering on a property, such as the route having a method selector. Assuming there can't be cycles:

fun Application.ktorMain() {
    // set up omitted
    val root = feature(Routing)
    val allRoutes = allRoutes(root)
    val allRoutesWithMethod = allRoutes.filter { it.selector is HttpMethodRouteSelector }
    allRoutesWithMethod.forEach {
        logger.info("route: $it")
    }
}

fun allRoutes(root: Route): List<Route> {
    return listOf(root) + root.children.flatMap { allRoutes(it) }
}

Example output:

22:41:42.148 [main] INFO  Service - route: /(authenticate adoptanimals-session-cookie)/shelter/{shelterVisualId}/(method:GET)
22:41:42.148 [main] INFO  Service - route: /private/healthcheck/(method:GET)

I've no doubt there'll be a better way built in eventually, but this did what we needed for now.

CarrotCodes on 7 Nov 2019

👍3

All 2 comments

I was interested logging all computed routes on service startup, in a cheap way, so did a small investigation.

You can traverse the tree of Routes, picking out leaves by filtering on a property, such as the route having a method selector. Assuming there can't be cycles:

fun Application.ktorMain() {
    // set up omitted
    val root = feature(Routing)
    val allRoutes = allRoutes(root)
    val allRoutesWithMethod = allRoutes.filter { it.selector is HttpMethodRouteSelector }
    allRoutesWithMethod.forEach {
        logger.info("route: $it")
    }
}

fun allRoutes(root: Route): List<Route> {
    return listOf(root) + root.children.flatMap { allRoutes(it) }
}

Example output:

22:41:42.148 [main] INFO  Service - route: /(authenticate adoptanimals-session-cookie)/shelter/{shelterVisualId}/(method:GET)
22:41:42.148 [main] INFO  Service - route: /private/healthcheck/(method:GET)

I've no doubt there'll be a better way built in eventually, but this did what we needed for now.

CarrotCodes on 7 Nov 2019

👍3

Please check the following ticket on YouTrack for follow-ups to this issue. GitHub issues will be closed in the coming weeks.