OpenAPI
Gateway-ul servește un document OpenAPI 3.1 la adresa:
GET https://api.rolchat.com/openapi.jsonDocumentul este asamblat la pornirea gateway-ului din documentele furnizate de fiecare serviciu: căile și schemele sunt combinate, duplicatele primesc ca prefix numele serviciului, iar orice cale marcată ca internă (doar pentru rețeaua de servicii) este eliminată. Contribuțiile sunt adăugate serviciu cu serviciu; familiile care nu au contribuit încă apar în referința endpointurilor, dar nu și în document. Până când documentul acoperă întregul API, consideră referința endpointurilor lista oficială a familiilor, iar pagina de convenții contractul oficial.
Fiecare contract RolChat, fie că apare în document sau nu, respectă convențiile: structura răspunsului, paginarea cu cursor, cheile de idempotență, antetele limitelor de rată și codurile de eroare.