Sape для Habr: Как проектировать спецификации OpenAPI для SPA

Мы используем подход Manifest First — первым создаётся манифест (в терминологии OpenAPI — спецификация). Он является источником истины для приложения. Относительно него реализуются функции фронтенда и бэкенда.

Идея в том, что все возможные разночтения по использованию API должны по возможности решаться на уровне спецификации. Описанные в ней требования обязательны для реализации на бэкенде и являются ориентиром для потребителя.

Этапы разработки, выработанные в нашей компании:

• Предоставление бизнес-требований в виде макетов в Figma и сопроводительной документации, описывающей логику работы UI.
• Составление по ним спецификации.
• Вёрстка макетов без интеграции с API.
• Параллельная разработка фронтенда и бэкенда.
• Финализация фронтенда для проверки взаимодействия с бэкендом.
• Проведение через QA на стейджинге.
• Релиз зоны или приложения.

Как показывает наш опыт, составление спецификации и вёрстка для SPA — относительно быстрые этапы. Наиболее объёмные по трудоёмкости этапы разработки — это реализация со стороны фронтенда и бэкенда. Однако они распараллеливаются, что даёт отличный выигрыш по времени. Применяя подход Manifest First, пользователи получают новые фичи значительнее быстрее, чем при традиционной разработке.

Как лучше всего проектировать API, используя OpenAPI рассказал подробно в статье Станислав Решетнев, Teamlead команды разработки Link Building в компании Sape.