Я создаю файл yaml openAPI 3.0 для справочной документации API нашего сайта. Позже я конвертирую файл yaml в уценку с помощью Widdershins и, наконец, конвертирую его в html с помощью Shins (это похоже на Slate).
Я создаю файл yaml с аннотациями в своем коде Java. Мы хотели бы включить длинное описание из 5 или 6 строк для многих наших конечных точек. Однако мы хотим, чтобы эти описания жили в других документах, отдельно от исходного кода Java. Таким образом, наши файлы Java не будут заполнены аннотациями. Есть ли аннотация Swagger, которая учитывает это? Например, мы хотели бы включить такую аннотацию перед объявлением конечной точки API. Аннотация должна указать генератору openAPI включить описание прямо в раздел файла yaml, который описывает эту конечную точку. Мы используем библиотеку Java io.swagger.models.Swagger.
Ура, -Гидеон