Мне нравится подход TDD к документированию вашего спокойного API с помощью spring-rest-docs. Тем не менее, мне нравится функция «API Playground», включенная в спецификации swagger. Я хотел бы, чтобы был способ получить лучшее из обоих миров.
Есть ли способ создать спецификации swagger2 из документов весеннего отдыха? может быть путем создания пользовательских препроцессоров запросов/ответов.
Есть ли у вас какие-либо мысли или рекомендации?
На данный момент в Spring REST Docs нет готовой поддержки для этого. Открытая вами задача будет отслеживать возможность добавления такой функциональности. А пока лучше всего было бы написать собственную реализацию Snippet, которая генерирует (часть) спецификацию Swagger.
Как правило, фрагмент Spring REST Docs имеет дело с документированием одного ресурса, тогда как спецификация Swagger описывает всю службу. Это означает, что реализация спецификации Swagger Snippet должна будет каким-то образом накапливать состояние, прежде чем в конце будет создана полная спецификация. Есть много способов сделать это (в памяти, несколько файлов, которые объединяются на этапе постобработки и т. д.). Мне не ясно, является ли один подход, очевидно, правильным, поэтому некоторые эксперименты были бы полезны. Если вы проводите какие-то эксперименты, пожалуйста, прокомментируйте вопрос, который вы открыли своими выводами.
