Документация REST APIОбщая программа
Доклад принят в программу конференции
Артём Кузвесов
Ideco
Являюсь frontend-разработчиком. Также писал серверную часть и мобильные приложения с использованием JavaScript.
Тезисы
Презентация - https://rawgit.com/ArtKuz/presentation-ideco-swagger/rit2017/
Часто возникает ситуация, когда нужна документация для API. Например, если вы работаете в команде, где роли backend- и frontend-разработчиков исполняют разные люди. Или нужно дать доступ к API сторонним разработчикам.
Такая документация должна быть всегда актуальной и легко читаемой. Как показывает практика, хранение её в google docs/Markdown/reStructuredText/etc. неудобно, и программисты часто забывают её вовремя актуализировать. Лучше всего, если документация API будет храниться максимально близко к коду.