Как документировать API, чтобы каждое обращение к документации не было мучительным - Егор Марюшко

Доклад с конференции Город-ИТ Егор Марюшко к.т.н. Основатель IISAD – АНО Международный институт системного анализа и проектирования, Основатель STENET school, Архитектор решений STENET school Как документировать API, чтобы каждое обращение к документации не было мучительным : В большинстве современных ИТ проектов, процесс проектирования API поставлен на поток, коллекции новых методов GET, POST, PUT, обновленные версии, новые очереди сообщений AMQP и топики в Kafka появляются, как грибы после дождя. Но зачастую использование хорошо спроектированной интеграции омрачается неудобной, неполной, не актуальной документацией. В докладе поговорим о том, какие есть варианты оформления документации к API от простых-ручных, к продвинутым-автоматизированным, а также о плюсах и минусах их использования.