OpenAPI
La passerelle sert un document OpenAPI 3.1 à l’adresse :
GET https://api.rolchat.com/openapi.jsonIl est assemblé au démarrage de la passerelle à partir des documents fournis par chaque service : les chemins et les schémas sont fusionnés, les doublons sont préfixés par le nom du service, et tout chemin marqué comme interne (réservé au maillage de services) est retiré. Les contributions sont ajoutées service par service ; les familles qui n’ont pas encore contribué apparaissent dans la référence des endpoints mais pas dans le document. Tant que le document ne couvre pas toute l’API, considérez la référence des endpoints comme la liste de référence des familles et la page des conventions comme le contrat de référence.
Chaque contrat RolChat, qu’il figure ou non dans le document, suit les conventions : l’enveloppe, la pagination par curseur, les clés d’idempotence, les en-têtes de limite de débit et les codes d’erreur.