网关在以下地址提供 OpenAPI 3.1 文档:
GET https://api.rolchat.com/openapi.json
该文档在网关启动时由各服务提供的文档汇编而成:路径和架构会被合并,重复项按服务划分命名空间,任何标记为内部(仅限服务网格)的路径都会被移除。各服务的描述正在逐个添加;尚未提供描述的系列会出现在端点参考中,但不在文档中。在文档覆盖全部接口之前,请将端点参考视为系列的权威列表,将约定页面视为权威契约。
每个 RolChat 契约,无论是否包含在文档中,都遵循约定:封装结构、游标分页、幂等键、速率限制标头和错误代码。