java - 从 Vertx 中的现有路由器生成 OpenApi 规范

Question

我正在尝试为 Vert.X Reactive 应用程序生成 swagger 文档。当前的解决方案是将静态 YAML 文件转换为 openapi.json 文件。

这是一项非常大量的工作，我想知道是否有办法自动完成这项工作。我知道有解决方案可以反过来做，但是因为它是一个现有的应用程序，所以这是不可能的。

我找到了以下库：https ://github.com/outofcoffee/vertx-oas这是我想要的方向，但遗憾的是不是最新的。

我希望这是可能的，但我现在有点卡住了。

标签： javaswaggerswagger-uivert.xopenapi

Answer 1

vertx-web-api-contract这里的管理员。不幸的是，由于 Vert.x Web 路由器 API 的设计，我们没有将 Vert.x Web 转换为 OpenAPI 的官方解决方案。

从路由器开始，无法推断出请求参数是什么、它们在请求中的位置、它们的模式、是否需要它们、它们的样式等。同样的事情适用于您无法推断的响应主体身体模式。

Jax-rs 和类似技术允许这种转换，因为它们使用一些声明性 API（例如注释）来描述请求合约，因此转换器只需阅读此描述即可将其转换为 OpenAPI 合约

弗朗切斯科