Конференция завершена. Ждем вас на TestDriven Conf в следующий раз!

Spring REST Docs: документация из тестов, а не наоборот

Cookbook - готовые рецепты

Доклад принят в программу конференции

Тезисы

Автоматическая генерация документации API на базе интеграционных тестов с помощью spring-restdocs (и аналогов).

Если генерить тесты по документации или спецификации (swagger), то получаем высокое покрытие, но люди такие тесты читать не будут — много лишнего и сломан порядок вызовов. Для того чтобы документация была полезна людям, она должна отражать конкретные частые примеры использования: аутентификация, проброс токенов, поиск, просмотр каталога, добавление товара в корзину, оформление покупки на партнерском сайте.

Как же такую документацию получить? Да и чтобы она сама обновлялась и была всегда актуальна?
Очень просто: взять интеграционные тесты API — и разметить их. Добавить туда порядок, примеры, описания полей. Приправить картинками / схемами по вкусу.

Запускаете сборку — получаете pdf, который не стыдно сразу отправить заказчику.

Ян Ашенкампф

Газпромбанк

Руководитель разработки Департамента ИТ Инвестиционного Бизнеса Газпромбанка.

Видео

Другие доклады секции

Cookbook - готовые рецепты