Создать спецификацию OpenApi из существующих маршрутизаторов в Vertx

Question

Я пытаюсь создать документацию по swagger для приложения Vert.X Reactive. Текущее решение - это статический файл YAML, который преобразуется в файл openapi.json.

Это очень много работы, и мне интересно, есть ли способ сделать это автоматизированным. Я знаю, что есть решения, чтобы сделать это наоборот, но поскольку это существующее приложение, это невозможно.

Я нашел следующую библиотеку: https://github.com/outofcoffee/vertx-oas Какое-то направление, в котором я хочу идти, но, к сожалению, не в курсе.

Я ожидаю, что это возможно, но сейчас я немного застрял.

Answer 1

vertx-web-api-contract здесь.К сожалению, у нас нет официального решения для преобразования Vert.x Web в OpenAPI из-за разработки API-интерфейсов Vert.x Web Router.

Начиная с маршрутизатора, нет способа определить параметры запроса, ихместоположение в запросе, их схема, если они требуются или нет, их стиль и т. д. То же самое относится к телам ответа, где вы не можете вывести схему тела.

Jax-rs и аналогичные технологии позволяютэто преобразование, потому что они описывают контракт запроса с использованием некоторого декларативного API (например, аннотации), поэтому конвертер просто должен прочитать это описание, чтобы перевести его в контракт OpenAPI

Francesco