Swagger — API бек-сервісів
Реєстр Swagger UI кожного бек-сервісу який споживає stack-client. Користуємось коли треба зробити deeplink на ендпоінт у секції Зв'язки UI-файлу.
Лінки
| Сервіс | Swagger UI |
|---|---|
stack | https://api.besocial.tech/api-docs/ |
stack-golden | https://api.besocial.tech/golden/api-docs/ |
stack-prime | https://api.besocial.tech/prime/api-docs/ |
stack-udate | (TODO) |
stack-chathouse | https://api.besocial.tech/chathouse/docs/ |
stack-academy | https://api.besocial.tech/academy/api-docs |
stack-ai | (TODO) |
Як лінкувати з UI-сторінок
У ## Зв'язки UI-файлу — deeplink на конкретний endpoint, не словесний опис запиту/відповіді (правило з CONVENTIONS).
Формат deeplink:
<swagger-url>#/<TagGroup>/<Operation>
Приклад:
- Бек: [getOperatorLadies (golden)](https://api.besocial.tech/golden/api-docs/v2#/Electron%20API/ElectronApiController.getOperatorLadies)Що НЕ описуємо тут
- Запит/відповідь конкретних ендпоінтів (це робота Swagger).
- Бек-логіку реалізації (це робота сервісних доків
docs/api/index.mdу кожному репо). - Топологію взаємодій сервісів (це
stack-docs/architecture/).