Когда мы плотно и много работаем с REST API JSON WordPress, WooCommerce, то нам нужно понимать как это все отлаживать и документировать. Разберем 2 полезных инструмента: Postman & Bruno.
Зачастую те кто плотно работают с REST API, используют Postman или Insomnia. Это лидеры рынка на сегодня и в целом все хорошо.
Но тут на рынке образовался новый игрок и зовут его Bruno.
Рассмотрим как это устроено, плюсы и минусы.
Если нужна теория то это тут https://wpcraft.ru/blog/tag/rest-api/
Postman & Insomnia
Postman, Insomnia и WordPress — это мощные инструменты, которые могут безупречно взаимодействовать вместе, чтобы упростить процесс создания и управления веб-сайтами через REST API. В то время как Postman упрощает процесс разработки и тестирования API, WordPress предоставляет интуитивно понятную платформу для создания и управления веб-сайтами. Интегрируя Postman с WordPress, разработчики могут улучшить свой рабочий процесс, эффективно сотрудничать и обеспечить бесперебойную работу API на своих веб-сайтах.
Все это здорово работает — пока REST API простой или мало разработчиков.
Но вот если образуется сложный REST API, и разработчиков много — нужно сохранять документацию и шарить ее между командой. И тут оказывается что эти инструменты стоят денег и особенно дорого стоит если надо хранить доки в Git.
И тут появляется Bruno
Bruno сильно проще чем Postman & Insomnia, но у него есть ряд преимуществ:
- он опенсорсный и бесплатный
- он позволяет сохранять коллекцию запросов и документировать их прямо в Git — для сохранения знаний в команде — для всех разработчиков
Попробовав его на одном проекте я понял что он во многих аспектах сильно интересней:
- он бесплатный и простой
- документация сохраняется в git — и доступна всем разработчикам в команде
- обновляется легко и просто по мере обновления кода
- когда разработчики делают код ревью в PR — они видят как изменения по коду, так и обновления документации в 1 PR — это очень удобно и сильно упрощает взаимодействие между бэками и фронтами
- когда надо сделать диагностику и ты ищешь точки входа в коде — сразу находишь код и тут же часто получается найти участок документации про нужные запросы и параметры — это экономит время
- все хранится в своем git — данные не уходят в чужие облака и нет рисков утечки чувствительных данных
Итого
Можно ли сказать что Bruno лучше чем Postman или Imsomnia?
Думаю что нет.
Лично в своем кейсе я попробовал Bruno и получил ряд весомых преимуществ с точки зрения взаимодействия команды. И мне в целом пока что его хватает и он заменяет мне Postman в 100% задач.
Однако я пока не планирую отказываться от Postman. Какие то задачи вероятно проще и удобней решать через него — как минимум эксперименты.
Но вот что касается документирования API — я с сегодняшнего дня точно начинаю использовать Bruno.
Команда также оценила преимущества этого инструмента.
