Мнение Программного комитета о докладе
Простой и быстрый вариант получения документации из API-тестов. Посмотрим на подходы и примеры реализации.
Spring REST Docs: документация из тестов, а не наоборот
Доклад принят в программу конференции
Целевая аудитория
Программисты и тестировщики, проектировщики API на Java и Spring и им сочувствующие.
Тезисы
Автоматическая генерация документации API на базе интеграционных тестов с помощью spring-restdocs (и аналогов).
Если генерить тесты по документации или спецификации (swagger), то получаем высокое покрытие, но люди такие тесты читать не будут — много лишнего и сломан порядок вызовов. Для того чтобы документация была полезна людям, она должна отражать конкретные частые примеры использования: аутентификация, проброс токенов, поиск, просмотр каталога, добавление товара в корзину, оформление покупки на партнерском сайте.
Как же такую документацию получить? Да и чтобы она сама обновлялась и была всегда актуальна?
Очень просто: взять интеграционные тесты API — и разметить их. Добавить туда порядок, примеры, описания полей. Приправить картинками / схемами по вкусу.
Запускаете сборку — получаете pdf, который не стыдно сразу отправить заказчику.
СТО стрима "Потребительские кредиты"
Газпромбанк
Газпромбанк — один из крупнейших банков России. Не просто банкиры: создают искусственный интеллект, придумывают новые цифровые продукты и поддерживают профессиональное комьюнити. Планируют стать самым дата-центричным и диджитализированным банком страны.
Видео
Другие доклады секции
Cookbook - готовые рецепты
