OpenAPI

Il gateway serve un documento OpenAPI 3.1 all’indirizzo:

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

Viene assemblato all’avvio del gateway a partire dai documenti forniti da ciascun servizio: percorsi e schemi vengono uniti, i duplicati ricevono un namespace per servizio e qualsiasi percorso contrassegnato come interno (solo mesh) viene rimosso. I contributi vengono aggiunti un servizio alla volta; le famiglie che non hanno ancora contribuito compaiono nel riferimento degli endpoint ma non nel documento. Finché il documento non copre l’intera superficie, considera il riferimento degli endpoint come l’elenco autorevole delle famiglie e la pagina delle convenzioni come il contratto autorevole.

Ogni contratto di RolChat, presente o meno nel documento, segue le convenzioni: l’envelope, la paginazione a cursore, le chiavi di idempotenza, le intestazioni dei limiti di frequenza e i codici di errore.