OpenAPI

Gatewayen levererar ett OpenAPI 3.1-dokument på:

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

Det sätts samman när gatewayen startar, utifrån de dokument som varje tjänst bidrar med: sökvägar och scheman slås samman, dubbletter får tjänstens namnrymd och varje sökväg som är markerad som intern (endast mesh) tas bort. Bidragen läggs till tjänst för tjänst; familjer som ännu inte har bidragit syns i endpoint-referensen men inte i dokumentet. Tills dokumentet täcker hela ytan ska du betrakta endpoint-referensen som den auktoritativa listan över familjer och sidan med konventioner som det auktoritativa kontraktet.

Varje RolChat-kontrakt, oavsett om det finns i dokumentet eller inte, följer konventionerna: omslaget, markörbaserad paginering, idempotensnycklar, headers för hastighetsgränser och felkoderna.