OpenAPI

Шлюз віддає документ OpenAPI 3.1 за адресою:

GET https://api.rolchat.com/openapi.json

Він збирається під час запуску шлюзу з документів, які надає кожен сервіс: шляхи та схеми об’єднуються, дублікати отримують простір імен сервісу, а всі шляхи, позначені як внутрішні (лише для mesh), видаляються. Описи додаються сервіс за сервісом; сімейства, які ще не додано, є в довіднику ендпоінтів, але відсутні в документі. Доки документ не охоплює весь API, вважайте довідник ендпоінтів авторитетним списком сімейств, а сторінку домовленостей - авторитетним контрактом.

Кожен контракт RolChat, у документі чи ні, дотримується домовленостей: конверт відповіді, курсорна пагінація, ключі ідемпотентності, заголовки лімітів запитів і коди помилок.