我有一个问题,我已经生成了 OpenApi Swagger 文件(swagger.json 和 swagger.yaml)是否有可能在 Ktor(kotlin)中以某种方式导入这些文件并在特定路径上启动 swagger-ui 服务器? 我去过ktor-swagger project但可以了解如何仅添加 json 文件来显示 swagger-ui。 有什么建议么 ?
最佳答案
让您可以从静态路由访问 json 文件
在资源目录中创建"file"目录
使用下一个代码从"file"目录路由静态文件
routing { static("/static") { resources("files") } //... }
给json文件命名“test.json”,然后放到“files”文件夹中
所以现在你运行应用程序并通过 http://localhost:8080/static/test.json 看到这个文件
然后我们需要安装和配置OpenApiGen
添加 OpenApiGen 依赖项,您可以在此处找到如何执行此操作 https://github.com/papsign/Ktor-OpenAPI-Generator
然后使用下面的代码
install(OpenAPIGen) { serveSwaggerUi = true swaggerUiPath = "/swagger-ui" }
现在您可以使用 http://localhost:8080/swagger-ui/index.html?url=/static/test.json URL 通过 swagger UI 查看您的文件
另外,您可以提供自己的路线来使用重定向
get("/api") {
call.respondRedirect("/swagger-ui/index.html?url=/static/test.json", true)
}
这将允许您只使用 http://localhost:8080/api
关于kotlin - Swagger-UI和Ktor如何导入swagger.json或.yaml文件启动Swagger-UI?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/59663420/