Is there a simple way to collect all existing Rout...

# ktor

[Fernando Sanchez (Perraco Labs)]

Is there a simple way to collect all existing Routing endpoints? I am using the next solution, as I couldn't find any simpler way to get such information:

@Serializable
public data class RouteInfo(val path: String, val method: String)

internal fun Application.collectRoutes(): List<RouteInfo> {
    val routes: MutableList<RouteInfo> = mutableListOf()

    // Helper function to recursively traverse and collect routes.
    fun RoutingNode.collect() {
        if (this.selector is HttpMethodRouteSelector) {
            val method: String = (this.selector as HttpMethodRouteSelector).method.value
            val path: String = this.extractRoutePath()
            val routeInfo = RouteInfo(path = path, method = method)
            routes.add(routeInfo)
        }
        this.children.forEach { it.collect() }
    }

    // Start collecting from the root route.
    this.routing { }.children.forEach { it.collect() }

    return routes.sortedWith(
        compareBy(
            { it.path },
            { it.method }
        )
    )
}

private fun RoutingNode.extractRoutePath(): String {
    val segments: MutableList<String> = mutableListOf()
    var currentRoute: Route? = this

    // Traverse the parent chain of the current route and collect path segments.
    while (currentRoute is RoutingNode) {
        val selector: RouteSelector = currentRoute.selector

        when (selector) {
            is PathSegmentConstantRouteSelector -> selector.value
            is PathSegmentParameterRouteSelector -> "{${selector.name}}"
            is PathSegmentOptionalParameterRouteSelector -> "{${selector.name}?}"
            is PathSegmentWildcardRouteSelector -> "*"
            is TrailingSlashRouteSelector -> ""  // Ignored for path construction
            is HttpMethodRouteSelector -> ""     // Ignored for path construction
            else -> ""
        }.let { segment ->
            if (segment.isNotEmpty()) {
                segments.add(segment)
            }
        }

        currentRoute = currentRoute.parent
    }

    return segments.asReversed().joinToString(separator = "/", prefix = "/").trimEnd('/')
}

[Dominik Sandjaja]

Is this the same requirement as answered here https://kotlinlang.slack.com/archives/C0A974TJ9/p1727248284882489?thread_ts=1727210870.754899&cid=C0A974TJ9 ?