Необходимо документирование API

[semen1032]

Проблема, с которой я столкнулся
Очень тяжело внедрять API при разработке/доработке фич, так как нет централизованного описания уже созданных API. Приходится искать их описание уже закрытых issue или PR или спрашивать у бэкенд разработчиков.

Так как проект уже разросся до достаточно больших размеров, количество разработчиков увеличилось, а также ожидается скорая разработка под мобильные платформы, требуется задокументировать все разработанные API-контроллеры, а также документировать новые.

@bearpro предлагаю всерьез заняться этим вопросом, пока еще не слишком поздно.

[bearpro]

И тратить на это ещё кучу времени.
Ты в какой форме представляешь документацию? Комменты? Я в них в лучшем случае смогу повторить исходный код, возможно в переводе на русский. Что-то более user-friendly? Ну так нам нужно отдельного человека иметь для поддержки такой документации. Или делать автоматизированно, на основе комментов, и тогда нужно либо много часов моей работы, либо - отдельного человека.

[bearpro]

То есть я не против документации в целом, но нам нужно хорошо подумать зачем она нам нужна и как она должна выглядеть.

[semen1032]

Нужно хотя бы централизованное место, в котором я могу посмотреть все доступные мне API.
Я ведь не требую документирование ради документирования. Пробелу описал выше.