В большинстве «больших» проектов, с которыми я работал, использовался REST API для Frontend-> Backend. Я использовал Firebase Cloud Firestore для некоторых небольших (однодневных / хакатон) проектов. Сейчас я думаю об использовании Firestore для более крупного проекта, но я не уверен, что это сработает.
Для "стандартного" REST API-проекта у меня была документация Swagger, где каждый разработчик мог видеть список всех конечные точки со структурами данных запроса / ответа. Как это работает с Firestore? Могу ли я создать аналогичную документацию для разработчиков, чтобы проверить структуру данных, чтобы они знали, что они могут добавить и что они должны прочитать? Или, может быть, есть другой способ?
Я думаю, может быть, нет никакого инструмента для такого рода документации, потому что структуры данных внешнего интерфейса определяют структуру базы данных? Но что, если я подключаю базу данных с двух или более платформ (например, веб, мобильных и облачных функций)? Как я могу синхронизировать знания о структурах данных между всеми разработчиками?
Я искал ответы на некоторые вопросы, но не мог найти ничего полезного, ожидаю совета по ручному ведению некоторой документации. Как это работает в ваших проектах? Есть ли какая-то автоматизация? Вручную написанная документация? Или нет документации - все "в коде"?