В данной статье я хочу рассказать, как использовать Swagger модуль для Play Framework, с примерами из реальной жизни. Я расскажу:

Как прикрутить последнюю версию Swagger-Play (модуль Play, позволяющий использовать аннотации swagger-api и генерировать на их основе документацию в соответствии со спецификацией OpenAPI) и как настроить swagger-ui (библиотеку javascript, служащую для визуализации сгенерированной документации)
Опишу основные аннотации Swagger-Core и расскажу об особенностях их использования для Scala
Расскажу, как правильно работать с классами моделей данных
Как обойти проблему обобщенных типов в Swagger, который не умеет работать с дженериками
Как научить Swagger понимать ADT (алгебраические типы данных)
Как описывать коллекции

Статья будет интересна всем, кто использует Play Framework на Scala и собирается автоматизировать документирование API.

Игра с открытым API: Swagger Play