Обзор основного репозитория бэкенда: структура, API и инструкции
Узнайте, как устроен основной монорепозиторий бэкенда: структура сервисов, работа с API, настройка окружения, документация и быстрый онбординг для новых разработчиков.
В этом руководстве мы узнаем, как устроен основной репозиторий с бэкэндом, чтобы быстро разобраться в его структуре и понять, где находятся ключевые элементы.
Мы рассмотрим, как работать с монорепозиторием, где находятся сервисы, как использовать и добавлять новые эндпоинты в API, а также как настраивать окружение для работы с разными базами данных. Это поможет быстрее начать работу с проектом и понять, как устроена интеграция сервисов.
Давайте начнем
Так, еще одно видео. Я хотел показать, как устроен наш основной репозиторий с бэкэндом. Это поможет быстро разобраться и найти нужные разделы. В общем, наш рендер бэкенд — это монорепозиторий, где находятся разные сервисы. Вот, по сути, тебя, Андрей, больше всего интересует наше API. Ну вот, в рамках проекта по интервью, если тебе нужны какие-то существующие ручки или нужно что-то добавить, надо сделать следующее.
У нас есть сервисы. В сервисах есть папка Го Хаб.
По сути, этот Го Хаб — это отдельный проект, связанный только с нашим API.
Вот здесь есть эндпоинты, которые можно использовать.
Там самое важное — это, наверное, джобс.
По-моему, Джобс.
Нет, вру, Джобс CRM.
Вот, у нас есть ручка jobs/slash. Это позволяет поднять, посмотреть, в Swagger будет видно, какие есть методы. Соответственно, сюда можно добавлять новые.
Это легко и понятно. Что еще хотел объяснить? Как быстро закодить это на Vibe?
У нас есть папка докс. Вот, и здесь есть раздел дев. В деве указаны различные инструкции по созданию чего-либо.
Вот, по-моему, здесь инструкцию по API я не прописывал. Думаю, Клод там либо кодексом разберется.
Вот, но! Условно, есть еще проджектс. В этих проджектсах содержатся проекты, которые я тоже там делаю. Я их документирую для будущего и кодинга.
Вот есть го эфирхаб апи, есть обзор. Вот здесь представлено полное описание нашего API. Вот, это тоже может быть полезно, чтобы мишка быстрее понимала контекст и что вообще происходит.
Вот, в целом, что еще добавить?
Что еще добавить? Добавить, наверное, можно следующее. У нас есть окружение для работы с продуктовой и тестовой базой данных. У нас в точке Энви есть го эфир Энв. Вот, он может быть тест, прод или локал. Если ставишь локал, тебе нужно в докере или у себя локально поднимать базу.
Если тестовую — у нас автоматически есть тестовая база данных, и он будет работать с ней.
Если прод, то уже с продуктовой. Это на всякий случай для тестирования. Ну и, наверное, всё. Но есть еще файл майк. В нем можно запустить наш основной API. Просто напишите "майк го хаб", и он его поднимет.
Вот, в целом, это все, что нужно знать об этом репозитории.
Если интересно быстро разобраться, что у нас есть помимо API, я в коде прописывал скилл онбординга.
Ну и тип слэш, там онбординг вводишь через код. Он либо сам проведет тебя по всем нашим сервисам, расскажет, как устроен слой работы с данными, как устроена бизнес-логика, как мы все пишем.
Либо ты можешь конкретно задать: расскажи мне про это, и он тебе расскажет. Вот, я это делал. В моей теории это может сократить время понимания того, что здесь происходит.
