Опиши свой RESTful — и тебе воздастся 😇
#frontend #backend #restful

При разработке SPA на реактивных фреймворках мы не хотим ждать готовности необходимых RESTful-методов для манипуляции данными из backend-части. Мы хотим максимально распараллелить процессы серверной и клиентской разработки.

Для того чтобы достичь этого, нам необходимо договориться о формате обмена данных между командами backend- и frontend-разработки: payload-данные и их типы, http-заголовки, данные авторизации и кеша. Иными словами, нужно спроектировать и формализовать RESTful API, с которым будет взаимодействовать наше SPA. Для этого мы используем несколько сервисов и инструментов.

Swagger. Этот инструмент может работать в режиме self-hosted и не принуждает к использованию платного Saas. Базируется на собственных спецификациях различных версий, известных как OpenAPI. Спроектированное API можно мокать и тестировать.

Oracle ApiAry. Saas основывается на другом языке описания API — API Blueprint. Сервис позволяет в режиме одного окна описывать методы RESTful API, смотреть документацию по ним и тестировать их работу. Для небольших команд и ограниченного количества проектов, хватает бесплатного тарифа.

Используя такие сервисы, frontend-разработчики могут делать тестовые rest-запросы к замоканным данным, которые имеют четко описанную структуру, приближенную к боевым реалиям. Документирование RESTful API избавляет от эффекта недопонимания между разработчиками, ведь все параметры и данные теперь четко описаны и имеют легенды, а результат ответа имеет проработанные вариации.