繁体   English   中英

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

[英]Generate OpenApi Specification from existing routers in Vertx

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

这是一项非常多的工作,我想知道是否有办法自动完成这项工作。 我知道有相反的解决办法,但因为它是一个现有的应用程序,这是不可能的。

我发现了以下库: https//github.com/outofcoffee/vertx-oas这是我想要的方向,但遗憾的是它不是最新的。

我希望它有可能但我现在有点卡住了。

vertx-web-api-contract mantainer here。 遗憾的是,由于Vert.x Web路由器API的设计,我们没有Vert.x Web到OpenAPI转换的官方解决方案。

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

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

弗朗切斯科

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM