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

时间:2019-03-29 13:04:35

标签: java swagger swagger-ui vert.x openapi

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

这是一项艰巨的工作,我想知道是否有一种自动化的方法。我知道有其他方法可以解决此问题,但是由于它是现有应用程序,所以这是不可能的。

我找到了以下库:https://github.com/outofcoffee/vertx-oas这是我想走的方向,但可惜的是它不是最新的。

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

1 个答案:

答案 0 :(得分:0)

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

从路由器开始,无法推断出什么是请求参数,它们在请求中的位置,它们的模式,是否需要它们,它们的样式等。同一件事适用于响应主体,您可以在其中不能推断出人体模式。

Jax-rs和类似技术允许此转换,因为它们使用一些声明性API(例如注释)描述了请求合同,因此转换器只需要阅读此描述即可将其转换为OpenAPI合同

弗朗切斯科