#gorib — Public Fediverse posts
Live and recent posts from across the Fediverse tagged #gorib, aggregated by home.social.
-
Документация, которая не врёт
С документацией к API есть две крайности, и обе плохие: написанная руками врёт через полгода, сгенерированная целиком стирает всё осмысленное, что в неё написали. Я перестал выбирать между ними и поделил файл: структура принадлежит коду и синхронизируется без спроса, проза принадлежит человеку и не трогается никогда. Заодно оказалось, что документацию можно проверять как golden-файл, и что проверить нельзя прозу, а вот её отсутствие можно.
https://habr.com/ru/articles/1080460/
#openapi #swagger #go #golang #документация_api #кодогенерация #rest_api #golden_tests #рефлексия #gorib
-
Документация, которая не врёт
С документацией к API есть две крайности, и обе плохие: написанная руками врёт через полгода, сгенерированная целиком стирает всё осмысленное, что в неё написали. Я перестал выбирать между ними и поделил файл: структура принадлежит коду и синхронизируется без спроса, проза принадлежит человеку и не трогается никогда. Заодно оказалось, что документацию можно проверять как golden-файл, и что проверить нельзя прозу, а вот её отсутствие можно.
https://habr.com/ru/articles/1080460/
#openapi #swagger #go #golang #документация_api #кодогенерация #rest_api #golden_tests #рефлексия #gorib
-
Документация, которая не врёт
С документацией к API есть две крайности, и обе плохие: написанная руками врёт через полгода, сгенерированная целиком стирает всё осмысленное, что в неё написали. Я перестал выбирать между ними и поделил файл: структура принадлежит коду и синхронизируется без спроса, проза принадлежит человеку и не трогается никогда. Заодно оказалось, что документацию можно проверять как golden-файл, и что проверить нельзя прозу, а вот её отсутствие можно.
https://habr.com/ru/articles/1080460/
#openapi #swagger #go #golang #документация_api #кодогенерация #rest_api #golden_tests #рефлексия #gorib