OpenAPI

เกตเวย์ให้บริการเอกสาร OpenAPI 3.1 ที่:

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

เอกสารนี้ประกอบขึ้นตอนเกตเวย์เริ่มทำงานจากเอกสารที่แต่ละบริการส่งมา: พาธและสคีมาถูกรวมกัน รายการซ้ำถูกแยกเนมสเปซตามบริการ และพาธใดก็ตามที่ทำเครื่องหมายว่าเป็นภายใน (ใช้เฉพาะในเมช) จะถูกนำออก บริการต่างๆ ทยอยส่งส่วนของตัวเองเข้ามา กลุ่มที่ยังไม่ได้ส่งจะปรากฏในเอกสารอ้างอิงเอนด์พอยต์แต่ไม่อยู่ในเอกสาร จนกว่าเอกสารจะครอบคลุมทั้งหมด ให้ถือว่าเอกสารอ้างอิงเอนด์พอยต์เป็นรายการกลุ่มที่เชื่อถือได้ และหน้าหลักการเป็นข้อตกลงที่เชื่อถือได้

ทุกข้อตกลงของ RolChat ไม่ว่าจะอยู่ในเอกสารหรือไม่ เป็นไปตามหลักการ: โครงสร้างการตอบกลับ การแบ่งหน้าด้วยเคอร์เซอร์ คีย์ idempotency เฮดเดอร์ขีดจำกัดอัตรา และรหัสข้อผิดพลาด