OpenAPI

Gatewayen leverer et OpenAPI 3.1-dokument på:

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

Det settes sammen når gatewayen starter, fra dokumentene hver tjeneste bidrar med: stier og skjemaer slås sammen, duplikater får navnerom etter tjeneste, og alle stier merket som interne (bare for tjenestenettet) fjernes. Bidragene legges til tjeneste for tjeneste; familier som ikke har bidratt ennå, vises i endepunktreferansen, men ikke i dokumentet. Inntil dokumentet dekker hele flaten, skal du behandle endepunktreferansen som den autoritative listen over familier og konvensjonssiden som den autoritative kontrakten.

Hver RolChat-kontrakt, enten den er i dokumentet eller ikke, følger konvensjonene: konvolutten, markørbasert paginering, idempotensnøkler, headere for hastighetsgrenser og feilkodene.