OpenAPI - генерировать код сервера для меняющегося API?

Question

Я поддерживаю приложение Java, где мы постоянно добавляем новые функции (изменения в API).Я хочу перейти к использованию OpenAPI как способ документирования API.Я вижу две школы мысли:

1. Напишите код, используйте некоторые аннотации для генерации спецификации OpenAPI.
2. Напишите OpenAPI, используйте его для генерации некоторого кода сервера.

Несмотря на то, что оба эти кода выглядят хорошими и изящными, серверный код просто заглушается, и тогда потребуется много ручных подключений сервисов.Несмотря на то, что это кажется единовременной ценой, в следующий раз, когда я обновляю интерфейс, мне кажется, что единственными двумя вариантами являются:

1. Сгенерируйте их все заново, заново выполните всю проводку вручную.
2. Вручную отредактируйте ранее сгенерированные классы, чтобы они соответствовали новому файлу спецификации (что может привести к ошибкам).

Я прав с этими параметрами?Если это так, то кажется, что использование кода для генерации спецификаций API действительно единственный разумный выбор.

Answer 1

Я бы порекомендовал подход API First, где вы описываете свой API в файле yaml и генерируете при каждом новом добавлении.

Теперь, как вы справляетесь с ручной перезаписью генератора вручную?Вы можете использовать наследование для создания моделей и контроллеров на основе сгенерированного кода.

Вы также можете использовать файл .ignore, поставляемый с генератором, если вы хотите быть уверены, что файлы не будут перезаписаны.