如何在Ktor中导入Swagger文件并在指定路由启动Swagger-UI？

当然可以！在Ktor中直接导入已生成的Swagger JSON/YAML文件并挂载Swagger-UI其实很简单，不需要依赖那些自动生成文档的库，只需要处理静态资源和路由转发就行。下面是具体的实现步骤：

首先你需要获取Swagger-UI的静态文件包：

• 去Swagger官方下载最新的Swagger-UI静态资源包，解压后得到dist目录；
• 将dist目录重命名为swagger-ui，放到你的Ktor项目的src/main/resources/static/目录下（如果没有static目录就新建一个）。

把已生成的swagger.json或swagger.yaml文件放到src/main/resources/static/api/目录下（同样，没有api目录就新建）。

在你的Ktor应用模块中，完成以下配置：

3.1 安装StaticContent插件 #

这个插件用于处理静态资源的访问：

import io.ktor.server.application.*
import io.ktor.server.plugins.staticcontent.*

fun Application.module() {
    // 安装静态资源插件
    install(StaticContent) {
        resources("static") // 指向resources下的static目录
    }

    // 后续路由配置...
}

3.2 配置路由 #

添加路由来暴露Swagger-UI入口和你的OpenAPI文件：

import io.ktor.server.response.*
import io.ktor.server.routing.*
import io.ktor.server.plugins.resources.respondResource

fun Application.module() {
    // 前面的StaticContent配置...

    routing {
        // 设置Swagger-UI的快捷入口，自动跳转到带OpenAPI文件参数的页面
        get("/swagger") {
            call.respondRedirect("/swagger-ui/index.html?url=/api/swagger.json")
            // 如果用YAML文件，就改成：/swagger-ui/index.html?url=/api/swagger.yaml
        }

        // 暴露你的Swagger JSON文件（打包成Jar也能正常访问）
        get("/api/swagger.json") {
            call.respondResource("static/api/swagger.json")
        }

        // 如果是YAML文件，添加这个路由
        get("/api/swagger.yaml") {
            call.respondResource("static/api/swagger.yaml")
        }
    }
}

启动你的Ktor应用后，访问http://localhost:<你的端口>/swagger，就能看到Swagger-UI加载并展示你的API文档了！

如果你不想手动处理静态资源，也可以用专门的Ktor Swagger-UI库来简化配置，比如io.github.bkmbigo:ktor-swagger-ui-jvm：

• 先添加Gradle依赖：

implementation("io.github.bkmbigo:ktor-swagger-ui-jvm:1.0.0")

• 然后在应用中安装插件并指定你的OpenAPI文件路径：

import io.github.bkmbigo.ktor.swaggerui.*

fun Application.module() {
    install(SwaggerUI) {
        swagger {
            swaggerUrl = "/api/swagger.json" // 指向你的OpenAPI文件路由
            title = "My API Documentation" // 自定义文档标题
        }
    }

    // 别忘了添加暴露OpenAPI文件的路由，和前面的一样
    routing {
        get("/api/swagger.json") {
            call.respondResource("static/api/swagger.json")
        }
    }
}

这样访问/swagger-ui就能直接看到你的文档了。

内容的提问来源于stack exchange，提问作者Artem Vinigradov