Ir al contenido

OpenAPI

El gateway sirve un documento OpenAPI 3.1 en:

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

Se ensambla al arrancar el gateway a partir de los documentos que aporta cada servicio: las rutas y los esquemas se combinan, los duplicados se separan por espacio de nombres del servicio y se elimina cualquier ruta marcada como interna (solo de la malla). Las aportaciones se añaden servicio a servicio; las familias que todavía no han aportado aparecen en la referencia de endpoints, pero no en el documento. Hasta que el documento cubra toda la superficie, considera la referencia de endpoints como la lista autorizada de familias y la página de convenciones como el contrato autorizado.

Todo contrato de RolChat, esté o no en el documento, sigue las convenciones: el sobre, la paginación por cursor, las claves de idempotencia, las cabeceras de límite de uso y los códigos de error.