Карта інтеграцій показує шлях, а не лише URL
Щоб зрозуміти інтеграцію, недостатньо перелічити endpoint-и. Потрібно простежити шлях від HTTP-запиту через обробник і бізнес-сервіс до бази даних, зовнішнього клієнта, черги або події, а потім знайти тест і конфігурацію, які підтверджують контракт.
`CODEBASE_INVENTORY.md` описує склад репозиторію, а `API_MAP.md` фіксує взаємозвʼязки між маршрутами, кодом, інтеграціями та середовищем.
| Вузол | Що перевірити |
|---|---|
| HTTP-маршрут | Метод, шлях і точку входу |
| Обробник | Контролер або функцію, що приймає запит |
| Бізнес-сервіс | Перетворення даних та правила |
| Інтеграція | БД, зовнішній клієнт, чергу або подію |
| Контракт | Авторизацію, конфігурацію та повʼязаний тест |
Досліджуйте один критичний сценарій
- Оберіть checkout, refund, підтримку або інший конкретний flow.
- Знайдіть маршрут і контролер.
- Пройдіть до сервісу та його залежностей.
- Перевірте записи до БД, зовнішні клієнти, черги та події.
- Знайдіть правила авторизації й середовищні змінні.
- Зіставте шлях із тестами.
- Занесіть лише підтверджені звʼязки та відкриті питання до
API_MAP.md.
Структура `API_MAP.md`
# API_MAP.md
## Клієнтські маршрути
## API підтримки
## API адміністративної панелі
## Зовнішні інтеграції
## Відкриті питання
| Метод і шлях | Обробник | Авторизація | Інтеграції | Тести |
| --- | --- | --- | --- | --- |
| POST /api/... | ... | ... | ... | ... | Інтеграційні докази
- контролер підтверджує існування маршруту;
- сервіс показує подальший напрям виконання;
- конфігурація виявляє залежності середовища;
- файл збірки підтверджує підключення бібліотеки;
- тест фіксує очікувану поведінку;
- коментар може бути підказкою, але не замінює кодову перевірку.
Карта живе разом із кодом
Після змін у маршрутах, сервісах або конфігурації переглядайте diff `API_MAP.md`. Документ має залишатися коротким, доказовим і синхронним із реалізацією, а не ставати одноразовою чернеткою.
Канонічне джерело уроку · JavaRush
Відкрити матеріал JavaRush