OpenAPI

Gateway cung cấp tài liệu OpenAPI 3.1 tại:

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

Tài liệu được lắp ráp khi gateway khởi động từ các tài liệu mà mỗi dịch vụ đóng góp: đường dẫn và schema được gộp, các mục trùng lặp được đặt namespace theo dịch vụ, và mọi đường dẫn được đánh dấu nội bộ (chỉ dùng trong mesh) đều bị loại bỏ. Các phần đóng góp được bổ sung lần lượt theo từng dịch vụ; các nhóm chưa đóng góp sẽ xuất hiện trong tài liệu endpoint nhưng không có trong tài liệu này. Cho đến khi tài liệu bao phủ toàn bộ API, hãy coi tài liệu endpoint là danh sách nhóm chính thức và trang quy ước là hợp đồng chính thức.

Mọi hợp đồng của RolChat, dù có trong tài liệu hay không, đều tuân theo quy ước: phong bì, phân trang bằng con trỏ, khóa idempotency, header giới hạn tốc độ và mã lỗi.