kotlin - 如何使用 http4k 公开 swagger UI？

Question

我正在使用 http4k framework 构建微服务使用他们的 Contract APIs .我可以轻松地在例如公开 swagger API 描述 JSON。 /swagger.json和

fun app(): HttpHandler = "/" bind contract {
    renderer = OpenApi3(ApiInfo("GoOut Locations API", "1.0"), Jackson)
    descriptionPath = "/swagger.json"
    routes += ...
}

有没有一种简单的方法来暴露 swagger UI以便 1) 我可以指定它可用的路径。 (eg. /swagger-ui) 2) UI 将被预先配置为从 descriptionPath 获取描述 JSON上面指定。

理想的 API 看起来像

fun app(): HttpHandler = "/" bind contract {
    renderer = OpenApi3(ApiInfo("GoOut Locations API", "1.0"), Jackson)
    descriptionPath = "/swagger.json"
    uiPath = "/swagger-ui"
    routes += ...
}

Answer 1

http4k 不附带 OpenApi UI 版本。您可以通过以下方式轻松发布 UI 版本:

将 OpenApi UI 解压到 src/main/resources/public 文件夹

使用 static路由块到服务器资源。这里有一个例子:https://github.com/http4k/http4k-by-example/blob/22dcc9a83c497253c29830d5bc981afa5fbbe4ff/src/main/kotlin/verysecuresystems/SecuritySystem.kt#L61